markdown-formatter

Crates.iomarkdown-formatter
lib.rsmarkdown-formatter
version0.0.13
sourcesrc
created_at2023-03-07 02:57:52.132587
updated_at2023-08-13 22:06:58.169366
descriptionFlavored Markdown (ZH) content formatter
homepagehttps://github.com/zhongdongy/markdown-formatter/
repositoryhttps://github.com/zhongdongy/markdown-formatter/
max_upload_size
id803219
size87,310
Zhongdong Yang (zhongdongy)

documentation

README

Markdown Formatter

Flavored Markdown (ZH) content formatter

这是一个非常简单的 Markdown 内容格式化命令行工具,它可以在任何主流操作系统运行。您需要安装 Cargo,然后使用:

cargo install markdown-formatter

最后将需要格式化的文件交给其命令行可执行程序即可,像这样:

md-fmt "content.md"

输出内容会在与输入文件同路径的 content.output.md 中。

选项

可以执行 md-fmt -hmd-fmt --help 来查看支持的选项。

预置风格

  1. Hugging Face 微信公众号

    这个公众号推文排版上的特点是清新简约,布局都比较清爽。其中对中文和英文标点符号的混排也经过了精心设计。如果要使用这一风格,可以使用命令行选项 --flavor-hugging-face-wechat

TODO

  • 自动图片上传到图床

开发说明

默认情况下,请使用 default feature,或者不手动指定。如果需要调试,可以手动使用 debug feature。

Cheatsheet

# 集成测试 markdown
cargo test --no-default-features --features debug --test markdown -- --nocapture
Commit count: 0

cargo fmt