Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support monorepos with multiple docs plugins #4085

Open
1 of 3 tasks
vjpr opened this issue Jan 21, 2021 · 2 comments
Open
1 of 3 tasks

Support monorepos with multiple docs plugins #4085

vjpr opened this issue Jan 21, 2021 · 2 comments
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@vjpr
Copy link

vjpr commented Jan 21, 2021

I am creating this issue to track all the issues related to using multiple docs plugins without a single repo.

Below is an example of my setup:

- . <- plugin-content-docs path
- .git
- tmp/logs
- .tmp/more-logs
- readme.md
- package.json
- docs <- docs for the monorepo
  - sidebar.js
  - readme.md 
- packages
  - docs-app
    - package.json
    - docusaurus.config.js 
  - pkg1 <- plugin-content-docs path
    - docs
      - sidebar.js
      - readme.md
  - pkg2 <- plugin-content-docs path
    - docs 

There are 3 docs plugins in use here. One for the monorepo root package, and two others for other packages.

I have indicated where the plugin's path config is set.

For the monorepo root docs plugin I set the path to be the root rather than the docs folder. This allows me to include the readme.md file in my docs.

Issues

@vjpr vjpr added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: needs triage This issue has not been triaged by maintainers labels Jan 21, 2021
@armano2

This comment has been minimized.

@Josh-Cena Josh-Cena removed the status: needs triage This issue has not been triaged by maintainers label Oct 30, 2021
@blessanm86
Copy link

We are using docusaurus in our NX monorepo. The docs is 1 app.
It would be great if we could specify folders outside the docs app. This way we could pull the docs from other apps and libs folder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Development

No branches or pull requests

4 participants