Documentation from several github repositories into a static site

Question

I need to some help to identify the correct solution that would help me create a seamless documentation for my friends. We have several repositories in which a doc folder with several .MD files are going to be placed

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

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

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

We would like to use something like vuepress to generate a static site. If there is any tool/framework which can easily solve this issue. I would be grateful

Thanks a lot for any response,we will definitely put below what we have done

Answer 1

You can accomplish this using MkDocs as your static site generator and the multirepo plugin. Below are the steps to get it all setup. I assume you have Python installed and you created a Python venv.

1. python -m pip install git+https://github.com/jdoiro3/mkdocs-multirepo-plugin
2. mkdocs new my-project
3. cd my-project
4. Add the below to your newly created mkdocs.yml. This will configure the plugin.

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

Now, you can run mkdocs serve or mkdocs build, which will build a static site with all the documentation in one site.