md-html-cli

KO | EN

gitlite — search

#react #ai #llm #go #golang #deep-learning #linux #macos #awesome #kubernetes #awesome-list #security #pytorch #mcp

(★ 11)

🔁 CLI tool for converting markdown to a single html file. 用于将 markdown 转换为单个 html 文件的 CLI 实用工具。

md-html-cli 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
<img alt="md-html-cli" src="assets/image/logo.png">
</p>
<h1 align="center">md-html-cli</h1>

<p align="center">
CLI tool for converting markdown to a single html file.
<br>
<a href="README-zh.md">🇨🇳 中文</a> | <b>🇺🇸 English</b>
</p>

## Installation

Install Go language `1.17` or above, and then execute the following command:

```shell
go install github.com/GoAid/md-html-cli@latest
```

## Usage

```shell
go run github.com/GoAid/md-html-cli@latest /?
```

```shell
Usage:
  go run github.com/GoAid/md-html-cli@latest [OPTIONS]

Application Options:
  /i, /input:             input Markdown
  /o, /output:            output HTML
  /r, /replace:           replace content key-value pairs
  /l, /lang:              html lang attribute value, default is en
  /t, /title:             custom html title, default is output file name
  /f, /favicon:           favicon image path, if embed is used, will embed by base64 encoding
  /e, /embed              embed image by base64 encoding
      /center             whether to center the image
  /m, /mathjax            use MathJax
  /s, /span               enable table row/col span
  /b, /border:            add a border style of a specified color to image labels, e.g. gray, #eee, rgb(0,0,0)
  /c, /css:               custom css file path
      /theme:[vue|side]   output HTML theme
      /toc                generate TOC
      /level:[1|2|3|4|5]  The heading level when generating TOC (default: 3)
  /g, /gen                use HTML comments to record generation time

Help Options:
  /?                      Show this help message
  /h, /help               Show this help message
```

### Sample

[GitHub Pages](https://GoAid.github.io/md-html-cli/index.html)

The html file is generated by following command

```bash
md-html-cli -i "example/*.md" -o gh-pages/index.html -l en -t "Example Page" -f example/img/go.png -ems -c example/css/custom-css.css --theme vue --toc --gen
```

### Example

<details>
<summary>Preview</summary>

| Markdown                                                                            | HTML                                                                                    |
|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
| ![mh-highlight-md.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-highlight-md.png)                       | ![mh-highlight-html.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-highlight-html.png)                       |
| ![mh-image-md.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-image-md.png)                               | ![mh-image-html.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-image-html.png)                               |
| ![mh-image-size-md.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-image-size-md.png)                     | ![mh-image-size-html.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-image-size-html.png)                     |
| ![mh-link-md.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-link-md.png)                                 | ![mh-link-html.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-link-html.png)                                 |
| ![mh-mathjax-md.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-mathjax-md.png)                           | ![mh-mathjax-html.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-mathjax-html.png)                           |
| ![mh-table-span-md.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-table-span-md.png)                     | ![mh-table-span-html.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-table-span-html.png)                     |
| ![mh-table-without-header-md.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-table-without-header-md.png) | ![mh-table-without-header-html.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-table-without-header-html.png) |
| ![mh-task-list-md.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-task-list-md.png)                       | ![mh-task-list-html.png](https://raw.githubusercontent.com/GoAid/md-html-cli/main/assets/image/docs/mh-task-list-html.png)                       |

</details>

## Development

### theme template

Create a folder for storing theme template files in the `theme` folder, 
and create a `.gohtml` type template file with the same name in the folder.

### template variable

| Variable                     | Description                                              |
|------------------------------|----------------------------------------------------------|
| `{{ .HTMLLang }}`            | HTML language attribute values, such as `en`, `zh`, etc. |
| `{{ .HTMLTitle }}`           | HTML custom title, the default is the output file name.  |
| `{{ if .Favicon }}{{ end }}` | Whether to add `favicon.ico`                             |
| `{{ .FaviconHref }}`         | `favicon.ico` tag element                                |
| `{{ if .TOC }}{{ end }}`     | Whether to generate a table of content                   |
| `{{ if .CSS }}{{ end }}`     | Whether to add a custom style                            |
| `{{ .ConvertedCSS }}`        | Customize style tag and content                          |
| `{{ if .MathJax }}{{ end }}` | Whether to use `MathJax` to render mathematical formulas |
| `{{ .MathJaxConfig }}`       | `MathJax` profile JS tag element                         |
| `{{ .MathJaxTeXSVG }}`       | `MathJax` rendering tool JS tag element                  |
| `{{ .ConvertedHTML }}`       | The converted HTML main content                          |
| `{{ .GeneratedAt }}`         | HTML comments to record generation time                  |

### template function

| Function                                                     | Description                                |
|--------------------------------------------------------------|--------------------------------------------|
| <code>{{ "&lt;!-- HTML tag --&gt;" &vert; safeHTML }}</code> | `safeHTML` is used to retain HTML comments |
| <code>{{ "/* CSS content */" &vert; safeCSS }}</code>        | `safeCSS` is used to retain CSS comments   |
| <code>{{ "/* JS content */" &vert; safeJS }}</code>          | `safeJS` is used to retain JS comments     |

## Acknowledgement

- <https://github.com/nocd5/md2html>
- <https://github.com/tscanlin/tocbot>
- <https://github.com/mathjax/MathJax>
- <https://github.com/shd101wyy/markdown-preview-enhanced>
- <https://github.com/PuerkitoBio/goquery>
- <https://github.com/jessevdk/go-flags>
- <https://github.com/yuin/goldmark>

md-html-cli

md-html-cli 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

md-html-cli

md-html-cli 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README