Organize output into folders

[ContrapunctusII]

Given a project structure like that:

|   .gitignore
|   .npmignore
|   config.json
|   package-lock.json
|   package.json
|   README.md
|   tsconfig.json
|   README.md
|
+---guides
|    config.md
|           
+---lib
|   |   errors.ts
|   |   index.ts
|   |   
|   +---classes
|   |       Account.ts
|   |       
|   \---types
|           index.d.ts

The Typedoc command I currently use is the following:

typedoc lib/**/* --out docs --entryPoints lib/index.ts --projectDocuments guides/*

Inside the generated output, I want the whole lib content to be placed into an API folder which will be showed in the sidebar while its content is not, unless the user clicks on the folder's name. How could I achieve that?

Thank you.

[Gerrit0]

Placing all of the entry points within a folder can't be done with a single invocation of TypeDoc as it will always place them at the top level. However, you can do this by rendering the docs to a JSON file, then merging the JSON file with your project documents in a second command.

typedoc 'lib/**/*' lib/index.ts --name API --json api.json
# or likely equivalent, without potential quoting issues with globs
typedoc --entryPointStrategy expand lib --name API --json api.json

# Then actually generate the site
typedoc --entryPointStrategy merge api.json --alwaysCreateEntryPointModule --projectDocuments 'guides/*'

# Clean up
rm api.json

[Dayday10]

Very well said

[ContrapunctusII]

Thanks, it works great! Just one thing: would it be possible to consider the API as a folder rather than a module in the documentation?

[Gerrit0]

"Folders" don't actually exist in TypeDoc's model structure, they're purely a rendering artifact of names which contain /, so to do that all of your modules need to have a name starting with API/. You could either use @module to do this, or a tiny plugin:

import * as td from "typedoc";

/** @param {td.Application} app */
export function load(app) {
    app.converter.on(td.Converter.EVENT_CREATE_DECLARATION, (_context, decl) => {
        if (decl.parent === decl.project) {
            decl.name = `API/${decl.name}`;
        }
    });
}

typedoc --entryPointStrategy expand lib --plugin ./api-folder-plugin.js

[ContrapunctusII]

Nice, thank you!