GitHub - p-balu/ghore
嘿，我目前正在寻找新的工作机会，你可以在这里找到我的简历。
Ghore（GitHub离线渲染器） #
内容 #
这是什么？ #
Ghore是一个开源的离线命令行接口（CLI）工具，专门为在GitHub上工作的开发人员和写作者设计。它的主要功能是将Markdown文件渲染为HTML，密切模拟GitHub Markdown风格。 使用户能够在将Markdown文档提交到存储库之前预览它们在GitHub上的外观。
特点
- 离线转换： 在没有互联网连接的情况下将Markdown文件转换为HTML。
- 监视更改： 当对输入的Markdown文件进行更改时，自动更新HTML输出。
- GitHub样式： HTML输出反映GitHub Markdown样式，保持一致性。
- 代码块高亮： 集成Starry Night (opens new window)确保美观和语法突出显示的代码块。
- 流程图支持： 还支持mermaid代码块的实时预览（GitHub的API不处理mermaid代码块）。
要求
要求使用最新版本的nodejs 20.10.0或更高版本。
安装
# 克隆存储库
git clone https://github.com/p-balu/ghore.git
# 进入项目目录
cd # 安装依赖项
npm install
# 本地启动应用程序
npm start `your/filepath/README.md`
## 全局安装`使用npm安装包`
安装全局包
### 以2种不同方式启动应用程序
如果您已经在包含README.md文件的目录中，则运行
```shell
ghore preview /path/toyour/README.md
配置 #
您可以通过修改包含的CSS文件（styles.css）来自定义HTML输出的外观。
贡献 #
欢迎贡献！请随时提出问题，提交拉取请求或提供反馈。
许可证 #
该项目根据MIT许可证 (opens new window)许可。