documentationjs / documentationjs/documentation
How to create parameter tables in markdown?
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 5.8k
- Forks
- 481
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
How can I use documentationjs to replicate the way doxme creates markdown tables for 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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza comparando la salida predeterminada de documentationjs en forma de lista anidada con el ejemplo vinculado de tabla de parámetros de doxme. Determina cómo documentationjs genera README.md a partir de JSDoc y define la salida de tabla deseada, incluidas las columnas de parámetro, tipo y descripción. Se considerará terminado cuando documentationjs pueda producir una tabla de parámetros de compacidad comparable.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100