documentationjs / documentationjs/documentation

Separate doc files for each module

Offen
#552 5 Kommentare 8 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
JavaScript
Sterne
5.8k
Forks
481
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Hi and thanks for great tool.

I was wondering if there is a way to generate separate `markdown` files for each module?

Like if I have `src/main.js`, `src/utils.js`, I want `src/main.md` and `src/utils.md` with correct linking if they have intersection.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die aktuelle Dokumentationsausgabe des Tools und die Einstiegspunkte für die Modulverknüpfung nachzuverfolgen; die Anfrage nennt src/main.js und src/utils.js als Beispieleingaben. Ermittle, wie Ausgabepfade und modulübergreifende Links dargestellt werden, und überprüfe anschließend, dass separate Dateien src/main.md und src/utils.md mit korrekten Links generiert werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.