documentationjs / documentationjs/documentation

How to create parameter tables in markdown?

Offen
#321 6 Kommentare 7 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

How can I use documentationjs to replicate the way [doxme](https://github.com/tmcw/doxme) creates markdown [tables for parameters](https://github.com/tmcw/doxme#parameters)?
### Parameters

| parameter | type | description |
| --- | --- | --- |
| `dox` | Object | the output of dox as a parsed JSON object |
| `readme` | boolean | whether to output a readme or just docs |
| `package` | Object | a parsed package.json |
| `travis` | boolean | whether to output a travis badge along with docs |

For me the default output of nested lists is harder to read and less compact.

I want to replace doxme with documentationjs for generating README.md from jsdoc.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die standardmäßige Ausgabe als verschachtelte Liste von documentationjs mit dem verknüpften doxme-Beispiel einer Parametertabelle zu vergleichen. Ermittle, wie documentationjs README.md aus JSDoc generiert, und definiere die gewünschte Tabellenausgabe einschließlich der Spalten für Parameter, Typ und Beschreibung. Als erledigt gilt die Aufgabe, wenn documentationjs eine vergleichbar kompakte Parametertabelle erzeugen kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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