Add ability to render documentation from multiple repositories
See original GitHub issueFeature request
Apologies if this is already a thing, but I couldn’t find any information. The feature I’m looking for would enable rendering documentation from multiple repositories under the same menu.
What problem does this feature solve?
This feature would enable pulling documentation from multiple git repos with “docs” folder and adding/managing it in an automated manner. Something similar to how Backstage TechDocs work.
So instead of having documentation generated per repo, a centralized documentation for all repos would be possible.
What does the proposed API look like?
Maybe docsify window object could contain array of repos?
<script>
window.$docsify = {
repos: [
{
repo: 'docsifyjs/docsify',
maxLevel: 3
}]
};
</script>
How should this be implemented in your opinion?
There should be one “main” repo that dictates central settings and all other repos get their own placeholder in menu (or on the page). Search and other plugins would have to work as it’s only one repo.
Are you willing to work on this yourself?
I can help with documentation and testing.
Issue Analytics
- State:
- Created 3 years ago
- Reactions:1
- Comments:34 (17 by maintainers)
Top GitHub Comments
I am trying to figure out the regex issue ,md extension which is getting added at the end, if I get correct regex rule. I can try it out and we can document as workaround.
yea, u can do the trick. there is our docs docsify that we display the
awesome docsify
selection from the awesome docsify repo. the point is using thealias
to rewrite the routers which redirect to other repos.