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}

By creating a documentation.yml file!, you can manually organize documentation any way you want! Unfortunately it doesn't yet affect Markdown output yet (tracking that issue here)

@tmcw, I don’t understand how to specify module TOC elements from your reference to documentation.yml. The TOC looks like it’s entirely based around classes. In the project I’m documenting, my modules just export functions, no classes. I’d like to have a TOC entry per module. Is that possible today?

yep. Want to know how to solve the function problem.

Looks like documentation still does not have an option to sort or group docs by module. On to another doc api.