vuepress
vuepress copied to clipboard
vuejs
Hosting documentation of multiple products under one repo
We have multiple products for which we need to document. Each documentation site would need some custom fonts, and custom vue components. We have built them and added them to appropriate .vuepress subfolder.
While we have exposed documentation for each product under different path, we have couple of shortcomings in hosting these docs for multiple products.
-
Seach. When user searches for something results shows across all products. We want to limit the results to product (pages under a specific path).
-
Header title. Header title is always main one what we configured in the vue config file. Is it possible to override this depending on the path of the url?
We achieved this as follows.
- Have single .vuepress folder with all components and base config
- Folder for each product with config that needs to be overridden for each product (typically nav and sidebar)
- Have couple of scripts when built, will copy the .vuepress into each product folder, overrides the config files and does vuepress build in that folder.
- Copy over the generated dist folder into main dist folder
- Repeat for each product.
While this may not be usual requirement but having some support to share single .vuepress folder across multiple independent product docs folder would be nice.
CC @ryannmedina this could be interesting for us as we turn attention towards splitting our implementation out for the individual products.
@brsanthu Thank you for sharing your experience, I am trying to do the same, hosting multiple documentations under one repo. I followed your steps.
However, I am not able to override the sidebar and navbar for the different documentations. The navbar and sidebar do not change when I switch from one documentation to the next. Even though the html files that were built contain a description to the right sidebars and navbars.
Any tips on how to achieve that ?
Actually my need was fulfilled with the multiple sidebar option that is native to Vuepress, it was enough to distinguish the 2 documentations