Marky

Markdown魔术师 🧙

特性

• 热重载预览 🔥
• 转换为HTML 🏭
• 主题！ ✨
• 扩展 - 数学、图表、语法高亮 🧩
• 下载base64编码的图像（png、jpg、svg）

• 示例
• 安装
• 帮助
• 构建
• 截图

示例

将doc.md转换为doc.html

marky doc.md

使用热重载启动本地预览服务器

marky doc.md --live

启用扩展

# Or use --all to enable all
marky doc.md --math --diagrams --highlight

将本地图像作为base64编码并压缩（测试版）

# possible values: local, remote, all
marky doc.md --include-images "local" --optimize-images
# or short
marky doc.md -zI local

使用fzf选择并使用不同的主题

marky doc.md --theme $(marky --themes | fzf)

从stdout管道传输并打开编译文件

cat doc.md | marky --out doc.html --open

查看--help获取更多信息

安装

使用cargo安装

cargo install marky

帮助

Markdown Magician 🧙

Usage: marky [OPTIONS] [PATH]

Arguments:
  [PATH]  Read input from file

Options:
      --completion <GENERATOR>
          [possible values: bash, elvish, fish, powershell, zsh]
  -t, --theme <THEME>
          Theme to use
      --string <STRING>
          Read input from string
      --themes
          List available themes
      --where-config
          Print config path
  -o, --out <OUT>
          Output file
      --stdout
          Output to stdout
  -H, --highlight
          Enable syntax highligting with highlight.js
  -M, --math
          Enable math rendering with KaTeX
  -D, --diagrams
          Enable UML diagrams rendering with Mermaid
  -I, --include-images <INCLUDE_IMAGES>
          Include images into file as base64 encoded [possible values: local, remote, all]
  -z, --optimize-images
          Optimize included images to make them smaller
  -A, --all
          Enable all extra renderers
  -w, --watch
          Recompile file on save
  -l, --live
          Live preview in the browser
      --port <PORT>
          Port of the live server [default: 8080]
  -O, --open
          Open output file in the default app
  -h, --help
          Print help
  -V, --version
          Print version

构建

git clone https://github.com/metafates/marky.git
cd marky
cargo install --path .

截图

一些示例...

marky README.md --theme sakura # default theme

marky README.md --theme air

marky README.md --theme retro

查看marky --themes以显示所有可用主题。

您还可以添加自己的主题，但尚未记录... 😴