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

Specify markdown flavor support #1108

Closed
JoelMarcey opened this issue Nov 12, 2018 · 0 comments
Closed

Specify markdown flavor support #1108

JoelMarcey opened this issue Nov 12, 2018 · 0 comments
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. documentation The issue is related to the documentation of Docusaurus

Comments

@JoelMarcey
Copy link
Contributor

📚 Documentation

We do not clearly specify the markdown flavor that we support. Let's specify it in our documentation.

I believe the right answer here is GitHub Flavored Markdown (GFM) since the original intent of Docusaurus was for projects to run on GitHub Pages.

Probably add it here: https://docusaurus.io/docs/en/doc-markdown

Have you read the Contributing Guidelines on issues?

Yes
@JoelMarcey JoelMarcey added documentation The issue is related to the documentation of Docusaurus difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. labels Nov 12, 2018
tsmrachel added a commit to tsmrachel/Docusaurus that referenced this issue Nov 18, 2018
@tsmrachel
docs : facebook#1108 specify markdown flavor support
5581dd9
@tsmrachel tsmrachel mentioned this issue Nov 18, 2018
Merged
tsmrachel added a commit to tsmrachel/Docusaurus that referenced this issue Nov 18, 2018
@tsmrachel
docs : facebook#1108 specify markdown flavor support
da0b64d
yangshun pushed a commit that referenced this issue Nov 19, 2018
@tsmrachel @yangshun
docs: specify markdown flavor support (#1118)
54b7662 
* docs : #1108 specify markdown flavor support

* Update api-doc-markdown.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. documentation The issue is related to the documentation of Docusaurus
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JoelMarcey @endiliey