我正在尝试以编程方式将 markdown 字符串解析为 github css 样式的 html 字符串。我已经尝试过以下方法,但由于 css 的原因,没有一个完全满足我的需求。
比较我的版本和github版本你会发现github版本更漂亮。 那么,是否有一个 javascript api 可以在这样的 html 文件中使用:
<script>
// this is a js code block
var md = "```js\nvar a = 1```"
var h = Convert(md)
// h will be the html string just like the one github preview generated
// (image you submit a github issue and click the preview button)
</script>
或者一个显示 markdown 文件的 github api,就像显示 html 文件的 htmlpreview 。
Highlight.js 只是一个语法高亮框架。您必须包含语法主题样式表来定义突出显示样式。 Github 的语法主题样式表是开源的,可以在here (github-syntax-light) 找到。将此样式表包含在您的文档中,您应该没问题。
ghmd
(GitHub Markdown) 是一个最小的工具 (~4 KB),可以使用 GitHub CSS 将任何 Markdown 文件转换为 HTML。它支持常规 Mardkown 和 GitHub Flavored Mardkown,以及自适应、浅色和深色模式。 结果看起来就像在 GitHub 中一样。
要安装它,只需运行:
pip install ghmd
并转换任何文件:
ghmd README.md --embed-css
它将在与原始文件相同的目录中生成一个
README.html
。 --embed-css
标志会将 CSS 样式嵌入到 HTML 文件中,因此它是独立的。如果你同意使用 CSS 作为 url 链接,你可以跳过它,它会更快,并且生成的文件会更小。
我经常使用它来以 HTML 形式发送 Markdown 文件,它的作用就像一个魅力。