Ef Markdown to HTML Converter
Ef 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:
ef /path/to/file.md # Convert /path/to/file.md to /path/to/file.html, titled "file"
ef /path/to/file.md -o /path/to/output.html # Convert /path/to/file.md to /path/to/output.html, titled "output"
ef /path/to/file.md -t 'Hello World!' # Convert /path/to/file.md to /path/to/file.html, titled "Hello World!"
USAGE:
ef [FLAGS] [OPTIONS]
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
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</p>
<p>ARGS:
<MARKDOWN_PATH> Specifies the path of your Markdown file
```</p>
<h2>Dependency</h2>
<p>Markdown is converted to HTML by the <a href="https://crates.io/crates/comrak">comrak</a> crate. The default stylesheet (the CSS file) is from <a href="https://github.com/sindresorhus/github-markdown-css">sindresorhus/github-markdown-css</a>. </p>
<p>If <code>```</code> is used in the input Markdown file, the <a href="https://highlightjs.org/">highlight.js</a> will be automatically embedded in the output HTML file. The preset supported languages are listed below.</p>
<ul>
<li>.properties</li>
<li>Apache</li>
<li>Bash</li>
<li>C</li>
<li>C#</li>
<li>C++</li>
<li>C-like</li>
<li>CSS</li>
<li>CoffeeScript</li>
<li>Diff</li>
<li>Go</li>
<li>HTML, XML</li>
<li>HTTP</li>
<li>JSON</li>
<li>Java</li>
<li>JavaScript</li>
<li>Kotlin</li>
<li>Less</li>
<li>Lua</li>
<li>Makefile</li>
<li>Markdown</li>
<li>Nginx</li>
<li>Objective-C</li>
<li>PHP</li>
<li>PHP Template</li>
<li>Perl</li>
<li>Python</li>
<li>Python REPL</li>
<li>Ruby</li>
<li>Rust</li>
<li>SCSS</li>
<li>SQL</li>
<li>Shell Session</li>
<li>Swift</li>
<li>TOML, INI</li>
<li>TypeScript</li>
<li>YAML</li>
</ul>
<p>If <code>#{{</code> - <code>}}#</code> or <code>#{{{</code> - <code>}}}#</code> is used in the input Markdown file, the <a href="https://www.mathjax.org/">mathjax.js</a> will be automatically embedded in the output HTML file. <code>#{{</code> and <code>}}#</code> are <code>inlineMath</code> delimiters. <code>#{{{</code> and <code>}}}#</code> are <code>displayMath</code> delimiters. The default <strong>mathjax.js</strong> are using the <a href="http://docs.mathjax.org/en/latest/web/components/combined.html#tex-mml-chtml">tex-mml-chtml</a> configuration file.</p>
<h2>A Markdown Example</h2>
<p><a href="https://github.com/magiclen/ef/blob/master/example.md">The Markdown File</a></p>
<p><a href="https://jsfiddle.net/magiclen/jgs324w0/latest">The HTML File</a></p>
<h2>License</h2>
<p><a href="LICENSE">MIT</a></p>
</body></html>