documentationjs / documentationjs/documentation

Separated sections for each module

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

Descrizione

I am having some trouble setting up the documentationJS for my project.
Right now I am using the command-line and I have been experimenting with:
```
documentation build -f md --document-exported > DOCS.md
documentation build -f md --document-exported --shallow > DOCS.md
documentation build client/ ** -f md --document-exported > DOCS.md
...
```
But all I achieved is generating untidy docs 😓.

The project structure is ⬇️
```
root
|
|-- client
| |
| | --modules
| | |
| | |--module A
| | | |--components
| | | |--containers
| | |--module B
| | |
| | |--module C
...
|--server
| |
| |--Pubs
| |
| |--Methods
| | |
| | |--foo.js
| | |
| | |--bar.js

```
I would like to obtain something like ⬇️

# Client #
## Module A
### Components
{...docs for each component}
### Containers
{...docs for each container}
## Module B
{...same for module B}
## Module C
{...same for module C}

...
# Server #
## Pubs
{ ... docs for pubs }
## Methods
### Foo
{ ... docs for foo}

### Bar
{ ... docs for bar}

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Non sono indicati file sorgente, test o punti di ingresso. Inizia riproducendo i comandi di build della documentazione elencati e confronta il loro output Markdown con la gerarchia Client/Server/module richiesta; il lavoro è terminato quando il documento generato contiene quelle sezioni separate e quei titoli di modulo annidati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
cli, documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.