Ask Your Question

Revision history [back]

click to hide/show revision 1
initial version

To link a README from a separate repository to another repository that utilizes both README and Docusaurus for constructing a documentation website, follow these steps:

  1. Create a new Markdown page in your Docusaurus site's docs directory.
  2. In the new Markdown page, create a link to the README file in the separate repository using the following syntax: [Link text](https://github.com/username/repository_name/blob/master/README.md)
  3. Save the Markdown page.
  4. In your Docusaurus configuration file, add the new Markdown page to the sidebar navigation as a new item under the appropriate section.
  5. Build and deploy your Docusaurus site to see the new link in action.

Note: make sure you have the proper permissions and licenses to link to another repository's README file.