开源改变世界!!

更容易贡献的文档 #824

推推 grbl 2年前 (2023-01-27) 111次浏览
关闭
绕线器 打开了这个问题 2017 年 11 月 28 日 · 1条评论
关闭

更容易贡献的文档#824

绕线器 打开了这个问题 2017 年 11 月 28 日 · 1条评论

注释

更容易贡献的文档 #824
所有者

UGS 文档使用名为MkDocs从 markdown 文件生成站点的工具。这个工具是一个很好的网站,但很难使用。

目标:

  • 非技术人员也可以轻松做出贡献。
  • 托管在 GitHub 页面上。
  • 从 Web 界面编辑 GitHub 上的文档。

这是一个包含许多可用工具的巨大列表。

浏览该列表,这里有一些选项:

  • DocumentUp – 立即美化您的 Github 存储库的README.md.
  • Flatdoc – 从 Github 存储库 README 文件或简单的 Markdown 文件创建设计良好的开源文档.
  • GitBook – 使用 GitHub/Git 和 Markdown 生成文档、书籍和练习的实用程序。
  • Jekyll 的文档主题 – 基于 Jekyll 构建的文档主题. 包括有关如何处理几乎所有技术文档场景的详细说明,从单一来源到条件过滤、PDF 输出、相关链接等。