Crates.io | ef |
lib.rs | ef |
version | 0.0.0 |
source | src |
created_at | 2021-03-16 08:23:07.93169 |
updated_at | 2021-03-16 08:23:07.93169 |
description | Ef is a tool for converting a Markdown file to a single HTML file with built-in CSS and JS. |
homepage | https://magiclen.org/ef |
repository | https://github.com/yuulive/ef |
max_upload_size | |
id | 369613 |
size | 890,234 |
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.
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] <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
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.
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.