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

Make Markdown dialect to use findable in documentation #822

Closed
sdruskat opened this issue Nov 15, 2018 · 0 comments · Fixed by #1710
Closed

Make Markdown dialect to use findable in documentation #822

sdruskat opened this issue Nov 15, 2018 · 0 comments · Fixed by #1710
Labels
A-Documentation Area: Documentation

Comments

@sdruskat
Copy link
Contributor

So I've found out that mdBook uses CommonMark via https://github.com/raphlinus/pulldown-cmark (via inspecting the Cargo.toml file), correct?

pulldown-cmark seems to implement some things that aren't in the CommonMark specs, like tables (unless I've overlooked them in the CM specs), which seem to follow https://michelf.ca/projects/php-markdown/extra/.

This is information that would be nice to have in the User Guide, especially for someone coming from other markdown dialects. I appreciate that this may be too specific for most use cases, so I probably wouldn't put it on the first page, but perhaps in the "Format" section?

I'd be happy to provide a PR if this suggestion finds any support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Area: Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants