documentationjs / documentationjs/documentation

How to create parameter tables in markdown?

Aperta
#321 6 commenti 7 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
JavaScript
Stelle
5.8k
Fork
481
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

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.