对网站文档生成器有什么建议吗？

Question

背景： 我是一名新的 IT 管理员，对于我支持的团队，我希望建立一个良好的文档中心，让他们可以轻松找到他们想要的内容。

我想要什么： 我希望找到一个项目的 github 存储库，该项目从 gitlab 存储库（在本地网络上）获取文档文件（可能是 markdown，...）并创建一个静态网站，并进行一些弹性搜索。以及按类别分类的方法（也许通过在文件标题中添加标签）。

*您知道有什么好的项目吗？ *

因为有数千个基于 github markdown 文件创建网站的项目，而我在所有这些项目之间迷失了方向。

有什么好的做法吗？

谢谢你。

Answer 1

当然！让我们深入研究每个提到的文档生成器的更多细节：

1. 多库龙：

   • 由 Facebook 开发：Docusaurus 是一个由 Facebook 开发和维护的开源项目。它旨在简化构建和维护文档网站的过程。
   • 现代静态网站生成器：Docusaurus 生成静态网站，使其快速且易于部署。生成的网站通常由 HTML、CSS 和 JavaScript 组成。

2. 狮身人面像：

   • 强大的文档工具：Sphinx是一个文档生成器，支持多种输出格式，包括HTML、PDF等。它起源于 Python 社区，但广泛用于用各种编程语言记录项目。
   • 用Python编写：Sphinx是用Python编写的，可以轻松集成到基于Python的项目中。它使用 reStructuredText 作为其标记语言。

3. GitBook：

   • 与平台无关的文档工具：GitBook 是一个适用于各种类型项目的文档平台。它支持协作编辑、版本控制和轻松部署。
   • 托管或自托管：您可以使用 GitBook 的托管服务或自行托管，从而使您可以灵活地管理文档的位置和方式。

4. MkDocs：

   • 快速且简单：MkDocs 以其速度和简单性而闻名。它允许您使用 Markdown 创建文档，并且生成的网站干净且易于导航。
   • 用Python编写：MkDocs是用Python编写的，它与Python生态系统集成得很好。它在记录软件项目方面特别受欢迎。

5. 阅读文档：

   • 托管平台和生成器：Read the Docs 既是文档托管平台又是文档生成器。它会自动从您的代码存储库构建文档，确保其保持最新状态。
   • 与版本控制集成：阅读文档与 GitHub、Bitbucket 和 GitLab 等版本控制系统无缝集成。

6. Vue新闻：

   • 简约静态站点生成器：VuePress 旨在简单易用。它使用 Vue.js 并支持使用 Vue 组件进行主题化。
   • 基于 Markdown：与 MkDocs 一样，VuePress 使用 Markdown 进行内容创建，使熟悉这种轻量级标记语言的人可以使用它。

7. 杰基尔：

   • Ruby 中的静态站点生成器：Jekyll 是一种流行的静态站点生成器，通常用于博客，但也可以用于文档目的。
   • GitHub Pages 支持：GitHub Pages 是 GitHub 提供的托管服务，支持 Jekyll。这样可以轻松地直接从 GitHub 存储库托管您的文档。

选择文档生成器时，请考虑您的特定项目要求、涉及的编程语言、易用性以及文档可能需要的任何特定功能。每个工具都有其优点并且适合不同的用例。