phpzlc/mark-git-doc

github markdown repository generates multi-version documents.

dev-main 2023-10-10 07:07 UTC

Requires

• php: >=7.1.3
• knplabs/github-api: *

MIT

• CJayHe

• markdown
• github
• document
• phpzlc
• multi-version

README

什么是标记语言Git多版本文档?

标记语言Git多版本文档是一种结合了Git版本控制特性与标记语言的文档管理方式。这种方法允许开发者为其项目的不同版本保留独特的文档，并利用标记语言的特性格式化和呈现内容。

项目优势

1. 版本管理: 利用Git的强大版本控制功能，轻松管理和追踪文档的变化。
2. 格式化呈现: 利用标记语言，如Markdown，使文档内容更加有结构，易于阅读。
3. 多版本支持: 轻松处理项目的各个版本的文档。
4. 多语言支持: 可支持多种语言，满足不同读者的需求。

项目功能

本项目可以从Git仓库拉取Markdown文档并将其转化为HTML格式，供用户浏览。项目主要由以下三个部分组成：

1. 基于Git的文档编写：用户可以在Git仓库中编写和修改Markdown文档。
2. 拉取程序: 该程序将Markdown文档从Git仓库中拉取到本地或服务器。
3. 渲染HTML文档: 将拉取到的Markdown文档转化为HTML，使其更易于阅读。

Symfony包

本项目是Symfony框架的一个包，意味着它可以轻松地集成到任何使用Symfony的项目中。

项目进展

目前，本项目的核心源码已完成。如果您想看到一个实际的示例，请访问 phpzlc.com/doc。

加入我们

如果您对本项目感兴趣或希望提供任何帮助，请加入我们的交流群 645891927 。我们欢迎任何形式的贡献和反馈！