documentationjs / documentationjs/documentation
Separated sections for each module
- Dominant language
- JavaScript
- Stars
- 5.8k
- Forks
- 481
- PR merge metrics
- No merged PRs in 30d
Description
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}
Contributor guide
Assessment
This issue has not been assessed yet.