question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add ability to render documentation from multiple repositories

See original GitHub issue

Feature 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:closed
  • Created 3 years ago
  • Reactions:1
  • Comments:34 (17 by maintainers)

github_iconTop GitHub Comments

1reaction
skumaravelancommented, Dec 6, 2021

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.

1reaction
Koooooo-7commented, Jan 8, 2021

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 the alias to rewrite the routers which redirect to other repos.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Living documentation from multiple repositories - Cucumber
Collating living documentation from across multiple repositories is hard, but Cucumber For Jira has the capability to make it simple.
Read more >
Documentation from several github repositories into a static site
You can accomplish this using MkDocs as your static site generator and the multirepo plugin. Below are the steps to get it all...
Read more >
Multi-repository Support Released! - Visual Studio Blog
Multi -repository support extends the capabilities of the Git Changes and Git Repository windows. This means managing your multi-repo scenarios ...
Read more >
6. Working with GitHub repositories on more than one computer
To make sure you keep up to date with the original, you need to tell git to add an “upstream” repository. The “upstream”...
Read more >
Using Multiple Repositories | Adobe Experience Manager
The contents from multiple git repositories need to be mapped to different directories within the single Cloud Manager git repository.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found