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

docs(v2): add examples to plugin usage doc #2351

Merged
merged 1 commit into from
Mar 3, 2020
Merged

docs(v2): add examples to plugin usage doc #2351

merged 1 commit into from
Mar 3, 2020

Conversation

Noah-Silvera
Copy link
Contributor

docs: add an example value for the remarkPlugins config option for plugin-content-blog and plugin-content docs.

Motivation

Initially I tried to use a string value with this config and got an esoteric error. Having an example of it's usage would help.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

View the using-plugins.md file, and ensure an example value for the remarkPlugins config exists for both the @docusaurus/plugin-content-docs and @docusaurus/plugin-content-blog config docs.

Add an example value for the remarkPlugins config option for plugin-content-blog and plugin-content docs
Initially I tried to use a string value with this config and got an esoteric error. Having an example of it's usage would help.
@Noah-Silvera Noah-Silvera requested a review from wgao19 as a code owner March 3, 2020 00:28
@docusaurus-bot
Copy link
Contributor

Deploy preview for docusaurus-2 ready!

Built with commit 6114ce3

https://deploy-preview-2351--docusaurus-2.netlify.com

@facebook-github-bot
Copy link
Contributor

Hi @Noah-Silvera!

Thank you for your pull request and welcome to our community.We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.

In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@yangshun yangshun changed the title Update using-plugins.md docs(v2): add examples to plugin usage doc Mar 3, 2020
Copy link
Contributor

@yangshun yangshun left a comment

Choose a reason for hiding this comment

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

Thanks!

@yangshun yangshun merged commit d4bbf00 into facebook:master Mar 3, 2020
@yangshun yangshun added the documentation The issue is related to the documentation of Docusaurus label Mar 5, 2020
@yangshun
Copy link
Contributor

yangshun commented Mar 5, 2020

@Noah-Silvera could you sign the CLA?

@Noah-Silvera
Copy link
Contributor Author

@Noah-Silvera could you sign the CLA?

Signed!

@yangshun yangshun added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation The issue is related to the documentation of Docusaurus pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants