Markdown 文本需要经过 markdown parser 的处理才能转成 html,才能被 preview。
不同种类的 markdown parser 提供的功能不一样。因此经常遇到在 VS code 上能 preview 的 markdown,上传到 github pages 之后,达不到预期效果。
比如,<details><summary>
里面插入代码,或者使用自定义的 css 等。在不同的 parser 中展示的结果不同。
选择一个自己喜欢的 Parser 很重要。
Language | Library (download project) |
---|---|
Perl | Original version |
JavaScript | CommonMark, Marked, Markdown-it, Remarkable, Showdown |
Ruby | Github Flavored Markup(GMF), Kramdown, Maruku, Redcarpet |
PHP | Cebe Markdown, Ciconia, Parsedown, PHP Markdown Extended |
Python | Python Markdown |
Markdown Parser 都支持的功能包括:Inline HTML, Automatic paragraphs, headers, blockquotes, lists, code blocks, horizontal rules, links, emphasis, inline code and images。 除了这些常规功能,每一个 parser 都支持其他特殊的功能。
参考: