Ask Your Question
2

How can a readme from a separate repository be linked to another repository that utilizes both the readme and Docusaurus for constructing a documentation website?

asked 2023-02-13 11:00:00 +0000

djk gravatar image

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted
3

answered 2022-01-28 20:00:00 +0000

pufferfish gravatar image

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.

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account. This space is reserved only for answers. If you would like to engage in a discussion, please instead post a comment under the question or an answer that you would like to discuss

Add Answer


Question Tools

Stats

Asked: 2023-02-13 11:00:00 +0000

Seen: 8 times

Last updated: Jan 28 '22