#markdown-html #markdown #markdown-converter #html #html-css #highlight #latex

程序+库 markdown2html-converter

将 Markdown 文件转换为包含内置 CSS 和 JS 的单个 HTML 文件的工具

27 个稳定版本

1.1.12 2023年11月13日
1.1.9 2022年5月24日
1.1.8 2022年3月18日
1.1.6 2021年9月19日
1.0.4 2018年10月17日

#686 in 命令行工具

Download history 38/week @ 2024-05-13 443/week @ 2024-05-20 20/week @ 2024-06-03 16/week @ 2024-06-17 1/week @ 2024-06-24 11/week @ 2024-07-01 55/week @ 2024-07-08 189/week @ 2024-07-15 13/week @ 2024-07-22 207/week @ 2024-07-29

464 每月下载量

MIT 许可证

1.5MB
1.5K SLoC

JavaScript 1.5K SLoC // 0.0% comments Rust 280 SLoC // 0.0% comments

Markdown 到 HTML 转换器

CI

Markdown 到 HTML 转换器是一个免费的工具,可以将 Markdown 文件转换为包含内置 CSS 和 JS 的单个 HTML 文件。

帮助

EXAMPLES:
markdown2html-converter /path/to/file.md                           # Convert /path/to/file.md to /path/to/file.html, titled "file"
markdown2html-converter /path/to/file.md -o /path/to/output.html   # Convert /path/to/file.md to /path/to/output.html, titled "output"
markdown2html-converter /path/to/file.md -t 'Hello World!'         # Convert /path/to/file.md to /path/to/file.html, titled "Hello World!"

Usage: markdown2html-converter [OPTIONS] <MARKDOWN_PATH>

Arguments:
  <MARKDOWN_PATH>  Specify the path of your Markdown file

Options:
  -t, --title <TITLE>                            Specify the title of your HTML file
  -o, --html-path <HTML_PATH>                    Specify the path of your HTML file
  -f, --force                                    Force to output if the HTML file exists
      --no-safe                                  Allow raw HTML and dangerous URLs
      --no-highlight                             Not allow to use highlight.js
      --no-mathjax                               Not allow to use mathjax.js
      --no-cjk-fonts                             Not allow to use CJK fonts
      --css-path <CSS_PATH>                      Specify the path of your custom CSS file
      --highlight-js-path <HIGHLIGHT_JS_PATH>    Specify the path of your custom highlight.js file
      --highlight-css-path <HIGHLIGHT_CSS_PATH>  Specify the path of your custom CSS file for highlight.js code blocks
      --mathjax-js-path <MATHJAX_JS_PATH>        Specify the path of your custom single MATH_JAX.js file
  -h, --help                                     Print help
  -V, --version                                  Print version

依赖项

Markdown 文件通过 comrak crate 转换为 HTML。默认样式表(CSS 文件)来自 sindresorhus/github-markdown-css

如果输入的 Markdown 文件中使用了 ```,则会在输出 HTML 文件中自动嵌入 highlight.js。以下列出了支持的预设语言。

  • Apache
  • Bash
  • C
  • C#
  • C++
  • CSS
  • Diff
  • Dockerfile
  • Go
  • HTML, XML
  • JSON
  • Java
  • JavaScript
  • Kotlin
  • Less
  • Lua
  • Makefile
  • Markdown
  • Nginx
  • Objective-C
  • PHP
  • PHP 模板
  • Perl
  • Python
  • Python REPL
  • R
  • Ruby
  • Rust
  • SCSS
  • SQL
  • Shell
  • Swift
  • TOML, INI
  • TypeScript
  • Visual Basic .NET
  • YAML

如果输入的 Markdown 文件中使用以下格式 #{{ - }}##{{{ - }}}#,则 mathjax.js 将自动嵌入到输出 HTML 文件中。 #{{}}#inlineMath 分隔符。 #{{{}}}#displayMath 分隔符。默认的 mathjax.js 使用的是 tex-mml-chtml 配置文件。

Markdown 示例

Markdown 文件

HTML 文件

许可证

MIT

依赖项

~8–19MB
~270K SLoC