#markdown #offline #github #preview #grip

应用 grup

离线 GitHub Markdown 预览器

4 个版本

0.2.3 2023 年 8 月 30 日
0.2.2 2022 年 6 月 9 日
0.2.1 2021 年 11 月 7 日
0.2.0 2019 年 1 月 16 日

可视化 中排名 #131

自定义许可证

26KB
273

grup - 离线 markdown 预览器

Latest Version Documentation License BuildStatus dependency status

什么是 grup?

grup 是一个受完美的 grip 启发的离线 markdown 预览器 —— 不需要将本地文件发送到 github 进行格式化,因此对于注重隐私的人来说(像我一样),更容易接受。

安装

安装 Rust 1.70 或更高版本后运行

cargo install grup

用法

获取 .md 文件(例如 README.md)的预览

grup README.md

这将打开本地 Web 服务器(默认为 127.0.01:8000)并显示渲染后的 markdown。
刷新页面也会更新文档。
完成后,通过按下 Ctrl+C 来停止 grup。

贡献者

感谢 @NickeZ

已知问题

运行 grup 时出现 "没有这样的远程或远程组:" 错误

尝试在 zsh 中运行 grup 时,grup 命令将被 zsh 的 git 插件定义的别名所掩盖。可以通过向您的 .zshrc 中添加以下内容来防止此情况,这将删除别名:

unalias grup

到您的 .zshrc 中,删除别名。
或者:添加指向安装位置的别名(例如 alias grupp="~/.cargo/bin/grup"

样式

默认情况下,html 输出使用 Sindre Sorhus 的 Github Markdown CSS 进行样式化。

依赖关系

~13–24MB
~347K SLoC