search

onury / docma

A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
https://onury.io/docma
MIT License
334 stars 34 forks source link

option to put API docs for each file on a separate page? #85

Closed trusktr closed 5 years ago

trusktr commented 5 years ago

I have a bunch of classes in separate files, and I noticed that it places all the docs for all the classes on a single page. Can we control this, and put them on separate pages?

trusktr commented 5 years ago

Looks like I have to specify each page? f.e.:

{
    "src": [
        {
            "Motor": "./src/core/Motor",
            "Node": "./src/core/Node",
            // etc...
        }
    ],
    "dest": "./docs"
}

Maybe I can just generate this file...

trusktr commented 5 years ago

It looks like the answer is to generate the src config so that my classes are on separate pages.

trusktr commented 5 years ago

After putting classes on separate pages, I realized that the sidebar can not link to all classes, only to the content of the current page (and same with search), so I made a new question about that: https://github.com/onury/docma/issues/86

onury commented 5 years ago

Sidebar is an outliner, not a navigation menu. It lists symbols of the API belonging to your current path. Use the top nav bar for navigating different documentations.