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
Is the flavor of Markdown used a secret? #1385
Comments
MkDocs uses Python-Markdown for Markdown parsing as is noted in the Markdown configuration documentation. You will also find a list of default extensions included by MkDocs and how to add more and alter the parser. Of course, as its name implies, Python-Markdown is a Markdown parser, not a Commonmark parser (CommonMark is not Markdown). But yeah, we could do a better job of documenting this. "Writing your Docs" seems like a natural place to find some guidance on that sort of thing. Also, I just noticed that where we do link to Python-Markdown, we use an old, dead link (the updated link is used above). So I've labeled this for a documentation update. Of course, PRs are appreciated. |
Present the sections in a logical manner: 1. File Layout (where to save documents) * Configure Navigation... 2. Writing with Markdown * Supported extensions... Added documentation for all included extensions. Also added some basic information about Markdown; pointing to the implementation and rules. Fixes mkdocs#1385.
Present the sections in a logical manner: 1. File Layout (where to save documents) * Configure Navigation... 2. Writing with Markdown * Supported extensions... Added documentation for all included extensions. Also added some basic information about Markdown; pointing to the implementation and rules. Fixes mkdocs#1385.
Present the sections in a logical manner: 1. File Layout (where to save documents) * Configure Navigation... 2. Writing with Markdown * Supported extensions... Added documentation for all included extensions. Also added some basic information about Markdown; pointing to the implementation and rules. Fixes mkdocs#1385.
Present the sections in a logical manner: 1. File Layout (where to save documents) * Configure Navigation... 2. Writing with Markdown * Supported extensions... Added documentation for all included extensions. Also added some basic information about Markdown; pointing to the implementation and rules. Fixes #1385, fixes #316, and fixes #1172.
@waylan Commonmark is the closest thing we have to a standard by my estimation. I understand if you don't want to implement it, but your statement is utterly confounding. |
The creator of Markdown (and the only person who gets to have a say in the matter) has indicated that the only standard are these rules. By its own admission, the Commonmark spec contradicts those rules in various respects. The fact that Commonmark calls itself "Markdown" does not make it "Markdown". IMO, they should stop calling it "Markdown" (which confuses people) and instead be honest and call it a new lightweight markup language 'inspired by Markdown'. |
I can't find a single reference in any of the docs to what flavor of markdown is supported and what tokens are acceptable.
I thought that would be one of the very first and most critical things documented prominently for this type of project as there is obviously no such thing in markdown as a "standard", CommonMark is the closest thing we have today which unfortunately MKDOCS doesn't appear to support.
There is a help section entitled "Writing your docs" subtitled "How to write and layout your markdown source files."
That is where I would have expected to see some indication of what markdown I can use.
The text was updated successfully, but these errors were encountered: