documentationjs / documentationjs/documentation
How to create parameter tables in markdown?
- Dominant language
- JavaScript
- Stars
- 5.8k
- Forks
- 481
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
Assessment
This issue has not been assessed yet.