#markdown #html #la-te-x #highlight #math-jax

bin+lib markdown2html-converter

A tool for converting a Markdown file to a single HTML file with built-in CSS and JS

22 stable releases

1.1.6 Sep 19, 2021
1.1.5 May 5, 2021
1.1.4 Apr 21, 2021
1.1.3 Mar 11, 2021
1.0.4 Oct 17, 2018

#147 in Command line utilities

44 downloads per month

MIT license

1MB
1.5K SLoC

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

Markdown to HTML Converter

CI

Markdown to HTML Converter is a free tool for converting a Markdown file to a single HTML file with built-in CSS and JS.

Help

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 [FLAGS] [OPTIONS] <MARKDOWN_PATH>

FLAGS:
        --no-safe         Allows 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
    -f, --force           Forces to output if the HTML file exists
    -h, --help            Prints help information
    -V, --version         Prints version information

OPTIONS:
    -t, --title <TITLE>                              Specifies the title of your HTML file
    -o, --html-path <HTML_PATH>                      Specifies the path of your HTML file
        --css-path <CSS_PATH>                        Specifies the path of your custom CSS file
        --highlight-js-path <HIGHLIGHT_JS_PATH>      Specifies the path of your custom highlight.js file
        --highlight-css-path <HIGHLIGHT_CSS_PATH>    Specifies the path of your custom CSS file for highlight.js code blocks
        --mathjax-path-path <MATHJAX_JS_PATH>        Specifies the path of your custom single MATH_JAX.js file

ARGS:
    <MARKDOWN_PATH>    Specifies the path of your Markdown file

Dependency

Markdown is converted to HTML by the comrak crate. The default stylesheet (the CSS file) is from sindresorhus/github-markdown-css.

If ``` is used in the input Markdown file, the highlight.js will be automatically embedded in the output HTML file. The preset supported languages are listed below.

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

If #{{ - }}# or #{{{ - }}}# is used in the input Markdown file, the mathjax.js will be automatically embedded in the output HTML file. #{{ and }}# are inlineMath delimiters. #{{{ and }}}# are displayMath delimiters. The default mathjax.js are using the tex-mml-chtml configuration file.

A Markdown Example

The Markdown File

The HTML File

License

MIT

Dependencies

~10MB
~202K SLoC