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.

Sign up for GitHub

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

Jump to bottom

Improve documentation on remark / rehype plugins #5492

Closed
Josh-Cena opened this issue Sep 7, 2021 · 2 comments · Fixed by #5766
Closed

Improve documentation on remark / rehype plugins #5492

Josh-Cena opened this issue Sep 7, 2021 · 2 comments · Fixed by #5766
Labels
documentation The issue is related to the documentation of Docusaurus

Comments

@Josh-Cena
Copy link
Collaborator

Josh-Cena commented Sep 7, 2021 •
edited
Loading

📚 Documentation

Elaborate on when, why, and how the user should use remark plugins.

Currently this section is very underdeveloped: https://docusaurus.io/docs/markdown-features/plugins#configuring-plugins
Users would want to know about:

  • The concepts of remark and rehype
  • When to use a plugin (e.g. injecting components at certain places, transforming image links)
  • How to develop a plugin (linking to the official remark doc, possibly, and the docusaurus plugins' source code as examples)

Have you read the Contributing Guidelines on issues?

Yes
@Josh-Cena Josh-Cena added documentation The issue is related to the documentation of Docusaurus status: needs triage This issue has not been triaged by maintainers labels Sep 7, 2021
@SanjaySinghRajpoot
Copy link

I would like to work on this issue.

@Josh-Cena
Copy link
Collaborator Author

Josh-Cena commented Sep 23, 2021 •
edited
Loading

@SanjaySinghRajpoot Why not, appreciate it ;)

If you need any help just open a PR and I can offer some suggestions. It isn't like I can't do it myself, I've repeated the same explanation multiple times on Discord

@cerkiewny cerkiewny mentioned this issue Oct 21, 2021
Merged
@Josh-Cena Josh-Cena removed the status: needs triage This issue has not been triaged by maintainers label Oct 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation The issue is related to the documentation of Docusaurus
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: elaborate on the usage of MDX plugins cerkiewny/docusaurus
2 participants
@Josh-Cena @SanjaySinghRajpoot