Load markdown from external sources
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Feature
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- javascript, nodejs
- Bereich
- cli, documentation
Rechercherichtung
Beginne damit zu prüfen, wie docsify-cli derzeit Verzeichnisse durchsucht und Markdown-Links sowie URL-Pfade erstellt. Definiere das Verhalten der externen README.md- und baseUrl-Zuordnungen, einschließlich lokaler Überschreibungen für Entwicklung und Tests. Als erledigt gilt die Aufgabe, wenn konfigurierte externe Repositories in der Navigation der veröffentlichten Dokumentation erscheinen können und lokale Zuordnungen wie vorgesehen funktionieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 781
- Forks
- 166
- Ø Merge
- 10 Std. 49 Min.
- Gemergte PRs (30 T.)
- 1
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus docsifyjs/docsify-cli
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
docsifyjs/docsify-cli#253 ·
-
enhancement
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
docsifyjs/docsify-cli#193 ·
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 55/100
docsifyjs/docsify-cli#191 · 2 Kommentare ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
docsifyjs/docsify-cli#188 ·
-
I would like to know why generating multi-level directories is not supportedEvtl. vergeben @theMyth333 hat das vor 1024 Tagen übernommen. Offen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 20/100
docsifyjs/docsify-cli#179 · 1 Kommentar ·
Alle Issues in docsifyjs/docsify-cli
Ähnliche Issues
-
documentation v2
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
modelcontextprotocol/servers#5170 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
SwiftKickMobile/skai#84 ·
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Billionmail/BillionMail#389 ·
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 92/100
Uniswap/tokenlists-org#3331 ·
-
beginner-friendly category:finding-titles community enhancement first-timers-only good first issue hacktoberfest help wanted low hanging fruit micro-contribution type: task up-for-grabs
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 85/100
Berserk-hub150/skillhawk#227 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 8 Tagen