Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copy to clipboard #39

Merged
merged 5 commits into from Nov 20, 2020
Merged

Conversation

JackieBinya
Copy link
Contributor

@JackieBinya JackieBinya commented Nov 17, 2020

This PR

  • Adds a copy to the clipboard component feature that can be used in Markdown content files.

Description

Previously this project used the @gridsome/source-filesystem and @gridsome/transformer-remark to process and read Markdown Content files. The main limitations of those plugins is that you cannot add Vue Components in Markdown. Using the @gridsome/vue-remark plugin, allows us to integrate Vuejs Components in Markdown.
In this PR I created a copy to the clipboard feature but I hope to create a github link for every content file in Markdown that will allow contributors to link to the raw Markdown files in this repo directly from the docs site.

Tests

I added a dummy CopyToClipboard component in the content file: advanced-customizations.md, for testing purposes.

  • Clone this repo
  • Checkout the git branch copy-to-clipboard
  • To view the changes in the browser visit localhost:8080/advanced-customizations

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

- Vue-remark will allow us to add Vuejs components in Markdown
- I had to reconfigure some content files so as to make them accessible to vue-remark
- Removes redundant plugins like transformer-remark and remark-prismjs
- Add a Vuejs plugin vue-clipboard2
- Creates logic, template and styles for the component feature
- Tests the feature in http://localhost:8080/advanced-customizations
@JackieBinya JackieBinya requested review from a team as code owners November 17, 2020 11:50
@JackieBinya JackieBinya mentioned this pull request Nov 17, 2020
7 tasks
Copy link
Contributor

@hugosolar hugosolar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

@hugosolar hugosolar merged commit 23daac6 into creativecommons:docs Nov 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants