reactjs - 从几个 github 存储库到静态站点的文档

Question

我需要一些帮助来确定正确的解决方案，以帮助我为我的 friend 创建无缝文档。我们有几个存储库，其中将放置一个包含多个 .MD 文件的 doc 文件夹

Repo1
|- Readme.MD
|-docs
  |- Installation.MD
  |- Usage.MD

Repo2
|- Readme.MD
|-docs
  |- Installation.MD
  |- Usage.MD

Repo3
|- Readme.MD
|-docs
  |- Installation.MD
  |- Usage.MD

我们想使用类似 vuepress 的东西来生成静态站点。是否有任何工具/框架可以轻松解决此问题。我将不胜感激

非常感谢任何回复，我们一定会把我们所做的放在下面

Answer 1

您可以使用 MkDocs 完成此操作作为您的静态站点生成器和 multirepo plugin .以下是完成所有设置的步骤。我假设您安装了 Python 并创建了一个 Python venv .

1. python -m pip install git+https://github.com/jdoiro3/mkdocs-multirepo-plugin
2. mkdocs 新建我的项目
3. cd 我的项目
4. 将以下内容添加到您新创建的 mkdocs.yml 中。这将配置插件。

plugins:
  - multirepo:
      repos:
        - section: Repo1
          import_url: {Repo1 url}
        - section: Repo2
          import_url: {Repo2 url}
        - section: Repo3
          import_url: {Repo3 url}

现在，您可以运行 mkdocs serve 或 mkdocs build，这将构建一个包含所有文档的静态站点。