docsifyjs / docsifyjs/docsify-cli

Load markdown from external sources

Aperta
#229 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
782
Fork
166
Merge medio
10h 49m
PR unite (30g)
1

Descrizione

I plan on using docsify for repo docs. One of the requirements I have is to have one repo link out to each repo's docs index file (README.md). This main repo will be the org-wide repo with a table of contents of all other documentation as well as organization/high-level documentation. The goal is to publish this org-wide docs repo and have it be the primary knowledge source for the organization which would include each repo's documentation on that website.

In order to do this, it would make sense if I can link to other external README.md files by URL. Right now docsify reads the directory to create table of contents and URL paths. Could it also grep (using ripgrep for fast file search) for all markdown links and source paths/pages from external? One could configure a baseUrl map so it only looks for links including a baseUrl in the map. The baseUrl table could allow for developers to map baseUrls to some overrides for local development and testing with the locally cloned repos.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.