4个版本 (重大更新)
0.4.0 | 2024年4月7日 |
---|---|
0.3.0 | 2024年3月15日 |
0.2.0 | 2024年3月11日 |
0.1.0 | 2024年3月10日 |
178 在 文本处理
每月下载量 270
15KB
209 代码行
mdopen
快速在浏览器中以GitHub风格预览本地Markdown文件。
不使用GitHub API,仅使用Rust编译Markdown到HTML。
安装
从crates.io安装
cargo install mdopen
或直接从本仓库安装
cargo install --git https://github.com/immanelg/mdopen.git
使用
启动服务器并在Firefox中打开文件
mdopen README.md TODO.md -b firefox
这将打开地址为 https://127.0.0.1:5032/README.md
和 https://127.0.0.1:5032/TODO.md
的文件。
您可以通过当前工作目录访问任何Markdown文件。
如果您访问 /
或其他目录路径,您还可以浏览当前目录。
特性
- 编译GitHub风格的Markdown到HTML
- 借用GitHub CSS,自动暗/亮模式
- 自动在默认浏览器中打开文件
- 目录列表/在文件系统中提供任何文件
- 语法高亮(通过highlight.js)
- 渲染LaTeX(通过KaTeX)
- 输出为独立的HTML文件
- 通过WS/SSE进行实时重新加载(tiny_http -> hyper)
欢迎反馈和pull requests。
致谢
grip 类似。
依赖项
~3.5MB
~75K SLoC