# barchart/documentation-generator architecture

> Architecture diagram of the GitHub repository barchart/documentation-generator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/barchart/documentation-generator
- Repository: https://github.com/barchart/documentation-generator

## Overview

This is a command-line generator for Barchart-style technical documentation websites. Users initialize a Docsify site, then generate content from JavaScript JSDoc, an OpenAPI file or URL, and release notes; they can also serve the site locally and manage cached source paths. The graph follows the CLI through generation and rendering, with shared project metadata, filesystem, templates, and cache layers. OpenAPI parsing and JSDoc rendering are distinct branches. Some capabilities are documented in the README but their full implementation was not sampled, so uncertain relationships are omitted.

Main entry points: [`bin/cli.js`](https://github.com/barchart/documentation-generator/blob/master/bin/cli.js) (Command interface), [`lib/commands/generateDocs.js`](https://github.com/barchart/documentation-generator/blob/master/lib/commands/generateDocs.js) (Generate docs), [`lib/commands/generateReleases.js`](https://github.com/barchart/documentation-generator/blob/master/lib/commands/generateReleases.js) (Generate releases), [`lib/docsify/index.js`](https://github.com/barchart/documentation-generator/blob/master/lib/docsify/index.js) (Docsify site setup)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI commands"]
  node_cli["Command interface<br/>[cli.js]"]
  node_generate["Generate docs<br/>[generateDocs.js]"]
  node_init["Initialize docs<br/>[initDocs.js]"]
  node_releasecmd["Generate releases"]
  node_cachecmd["Cache manager<br/>[cacheManager.js]"]
  node_clearcache["Clear cache<br/>[clearCache.js]"]
  node_serve["Serve site<br/>[serveDocs.js]"]
end

subgraph group_site["Site content"]
  node_docsify["Docsify site setup<br/>[index.js]"]
  node_templates["Site templates<br/>[index.js]"]
end

subgraph group_generators["Content generators"]
  node_jsdoc["JSDoc generator<br/>[JSDocGenerator.js]"]
  node_jsdocplugin["JSDoc rendering plugin<br/>[helpers.js]"]
  node_openapi["OpenAPI generator"]
  node_dmd["OpenAPI Markdown renderer<br/>[index.js]"]
  node_htmlparse["HTML description parser<br/>[HTMLParser.js]"]
  node_nodes["HTML node factory<br/>[NodeFactory.js]"]
  node_openapihelpers["OpenAPI render helpers<br/>[helpers.js]"]
  node_base["Generator base<br/>[BaseGenerator.js]"]
  node_releases["Release note renderer<br/>[index.js]"]
end

subgraph group_shared["Shared services"]
  node_metadata["Project metadata<br/>[ProjectMeta.js]"]
  node_options["Generator options<br/>[Options.js]"]
  node_cache[("Path cache<br/>[index.js]")]
  node_filesystem["Safe filesystem<br/>[index.js]"]
end

node_user(("Documentation author"))

node_user -->|"runs commands"| node_cli
node_cli -->|"dispatches generate"| node_generate
node_cli -->|"dispatches init"| node_init
node_cli -->|"dispatches releases"| node_releasecmd
node_cli -->|"dispatches clear-cache"| node_clearcache
node_cli -->|"dispatches cache"| node_cachecmd
node_cli -->|"dispatches serve"| node_serve
node_generate -->|"loads metadata"| node_metadata
node_generate -->|"creates options"| node_options
node_generate -->|"initializes site"| node_docsify
node_generate -->|"runs generator"| node_jsdoc
node_generate -->|"runs generator"| node_openapi
node_generate -->|"generates releases"| node_releasecmd
node_init -->|"initializes site"| node_docsify
node_init -->|"generates releases"| node_releasecmd
node_releasecmd -->|"loads metadata"| node_metadata
node_releasecmd -->|"renders notes"| node_releases
node_releasecmd -->|"registers templates"| node_templates
node_cachecmd -->|"loads metadata"| node_metadata
node_cachecmd -->|"reads and updates"| node_cache
node_clearcache -->|"clears saved paths"| node_cache
node_serve -->|"serves site"| node_docsify
node_docsify -->|"compiles site pages"| node_templates
node_jsdoc -->|"extends generator"| node_base
node_jsdoc -.->|"uses rendering plugin"| node_jsdocplugin
node_openapi -->|"extends generator"| node_base
node_openapi -->|"renders Markdown"| node_dmd
node_dmd -->|"uses helpers"| node_openapihelpers
node_openapihelpers -->|"parses descriptions"| node_htmlparse
node_htmlparse -->|"creates nodes"| node_nodes
node_jsdoc -->|"writes generated pages"| node_filesystem
node_openapi -->|"reads and writes files"| node_filesystem
node_base -->|"stores source paths"| node_cache
node_base -->|"checks source paths"| node_filesystem
node_docsify -->|"writes site files"| node_filesystem
node_releases -->|"uses templates"| node_templates

click node_cli "https://github.com/barchart/documentation-generator/blob/master/bin/cli.js"
click node_generate "https://github.com/barchart/documentation-generator/blob/master/lib/commands/generateDocs.js"
click node_init "https://github.com/barchart/documentation-generator/blob/master/lib/commands/initDocs.js"
click node_releasecmd "https://github.com/barchart/documentation-generator/blob/master/lib/commands/generateReleases.js"
click node_cachecmd "https://github.com/barchart/documentation-generator/blob/master/lib/commands/cacheManager.js"
click node_clearcache "https://github.com/barchart/documentation-generator/blob/master/lib/commands/clearCache.js"
click node_serve "https://github.com/barchart/documentation-generator/blob/master/lib/commands/serveDocs.js"
click node_docsify "https://github.com/barchart/documentation-generator/blob/master/lib/docsify/index.js"
click node_templates "https://github.com/barchart/documentation-generator/blob/master/lib/templates/index.js"
click node_jsdoc "https://github.com/barchart/documentation-generator/blob/master/lib/generators/jsdoc/JSDocGenerator.js"
click node_jsdocplugin "https://github.com/barchart/documentation-generator/blob/master/lib/generators/jsdoc/dmd-plugin/helper/helpers.js"
click node_openapi "https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/OpenAPIGenerator.js"
click node_dmd "https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/openapi2md/dmd/index.js"
click node_htmlparse "https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/html/HTMLParser.js"
click node_nodes "https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/html/NodeFactory.js"
click node_openapihelpers "https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/openapi2md/dmd/helpers/helpers.js"
click node_base "https://github.com/barchart/documentation-generator/blob/master/lib/generators/base/BaseGenerator.js"
click node_releases "https://github.com/barchart/documentation-generator/blob/master/lib/releases/index.js"
click node_metadata "https://github.com/barchart/documentation-generator/blob/master/lib/common/projectMeta/ProjectMeta.js"
click node_options "https://github.com/barchart/documentation-generator/blob/master/lib/common/options/Options.js"
click node_cache "https://github.com/barchart/documentation-generator/blob/master/lib/common/cache/index.js"
click node_filesystem "https://github.com/barchart/documentation-generator/blob/master/lib/common/fsSafe/index.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_generate,node_init,node_releasecmd,node_cachecmd,node_clearcache,node_serve toneBlue
class node_docsify,node_templates toneAmber
class node_jsdoc,node_jsdocplugin,node_openapi,node_dmd,node_htmlparse,node_nodes,node_openapihelpers,node_base,node_releases toneMint
class node_metadata,node_options,node_cache,node_filesystem toneRose
class node_user toneIndigo
```

## Components

### CLI commands

- [Command interface](https://github.com/barchart/documentation-generator/blob/master/bin/cli.js): `bin/cli.js`
- [Generate docs](https://github.com/barchart/documentation-generator/blob/master/lib/commands/generateDocs.js): `lib/commands/generateDocs.js`
- [Initialize docs](https://github.com/barchart/documentation-generator/blob/master/lib/commands/initDocs.js): `lib/commands/initDocs.js`
- [Generate releases](https://github.com/barchart/documentation-generator/blob/master/lib/commands/generateReleases.js): `lib/commands/generateReleases.js`
- [Cache manager](https://github.com/barchart/documentation-generator/blob/master/lib/commands/cacheManager.js): `lib/commands/cacheManager.js`
- [Clear cache](https://github.com/barchart/documentation-generator/blob/master/lib/commands/clearCache.js): `lib/commands/clearCache.js`
- [Serve site](https://github.com/barchart/documentation-generator/blob/master/lib/commands/serveDocs.js): `lib/commands/serveDocs.js`

### Site content

- [Docsify site setup](https://github.com/barchart/documentation-generator/blob/master/lib/docsify/index.js): `lib/docsify/index.js`
- [Site templates](https://github.com/barchart/documentation-generator/blob/master/lib/templates/index.js): `lib/templates/index.js`

### Content generators

- [JSDoc generator](https://github.com/barchart/documentation-generator/blob/master/lib/generators/jsdoc/JSDocGenerator.js): `lib/generators/jsdoc/JSDocGenerator.js`
- [JSDoc rendering plugin](https://github.com/barchart/documentation-generator/blob/master/lib/generators/jsdoc/dmd-plugin/helper/helpers.js): `lib/generators/jsdoc/dmd-plugin/helper/helpers.js`
- [OpenAPI generator](https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/OpenAPIGenerator.js): `lib/generators/openapi/OpenAPIGenerator.js`
- [OpenAPI Markdown renderer](https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/openapi2md/dmd/index.js): `lib/generators/openapi/openapi2md/dmd/index.js`
- [HTML description parser](https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/html/HTMLParser.js): `lib/generators/openapi/html/HTMLParser.js`
- [HTML node factory](https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/html/NodeFactory.js): `lib/generators/openapi/html/NodeFactory.js`
- [OpenAPI render helpers](https://github.com/barchart/documentation-generator/blob/master/lib/generators/openapi/openapi2md/dmd/helpers/helpers.js): `lib/generators/openapi/openapi2md/dmd/helpers/helpers.js`
- [Generator base](https://github.com/barchart/documentation-generator/blob/master/lib/generators/base/BaseGenerator.js): `lib/generators/base/BaseGenerator.js`
- [Release note renderer](https://github.com/barchart/documentation-generator/blob/master/lib/releases/index.js): `lib/releases/index.js`

### Shared services

- [Project metadata](https://github.com/barchart/documentation-generator/blob/master/lib/common/projectMeta/ProjectMeta.js): `lib/common/projectMeta/ProjectMeta.js`
- [Generator options](https://github.com/barchart/documentation-generator/blob/master/lib/common/options/Options.js): `lib/common/options/Options.js`
- [Path cache](https://github.com/barchart/documentation-generator/blob/master/lib/common/cache/index.js): `lib/common/cache/index.js`
- [Safe filesystem](https://github.com/barchart/documentation-generator/blob/master/lib/common/fsSafe/index.js): `lib/common/fsSafe/index.js`

### Other components

- **Documentation author**

## Connections

- Documentation author → Command interface: runs commands (evidence: `README.md`)
- Command interface → Generate docs: dispatches generate (evidence: `bin/cli.js`)
- Command interface → Initialize docs: dispatches init (evidence: `bin/cli.js`)
- Command interface → Generate releases: dispatches releases (evidence: `bin/cli.js`)
- Command interface → Clear cache: dispatches clear-cache (evidence: `bin/cli.js`)
- Command interface → Cache manager: dispatches cache (evidence: `bin/cli.js`)
- Command interface → Serve site: dispatches serve (evidence: `bin/cli.js`)
- Generate docs → Project metadata: loads metadata (evidence: `lib/commands/generateDocs.js`)
- Generate docs → Generator options: creates options (evidence: `lib/commands/generateDocs.js`)
- Generate docs → Docsify site setup: initializes site (evidence: `lib/commands/generateDocs.js`)
- Generate docs → JSDoc generator: runs generator (evidence: `lib/commands/generateDocs.js`)
- Generate docs → OpenAPI generator: runs generator (evidence: `lib/commands/generateDocs.js`)
- Generate docs → Generate releases: generates releases (evidence: `lib/commands/generateDocs.js`)
- Initialize docs → Docsify site setup: initializes site (evidence: `lib/commands/initDocs.js`)
- Initialize docs → Generate releases: generates releases (evidence: `lib/commands/initDocs.js`)
- Generate releases → Project metadata: loads metadata (evidence: `lib/commands/generateReleases.js`)
- Generate releases → Release note renderer: renders notes (evidence: `lib/commands/generateReleases.js`)
- Generate releases → Site templates: registers templates (evidence: `lib/commands/generateReleases.js`)
- Cache manager → Project metadata: loads metadata (evidence: `lib/commands/cacheManager.js`)
- Cache manager → Path cache: reads and updates (evidence: `lib/commands/cacheManager.js`)
- Clear cache → Path cache: clears saved paths (evidence: `lib/commands/clearCache.js`)
- Serve site → Docsify site setup: serves site (evidence: `lib/commands/serveDocs.js`)
- Docsify site setup → Site templates: compiles site pages (evidence: `lib/docsify/index.js`)
- JSDoc generator → Generator base: extends generator (evidence: `lib/generators/jsdoc/JSDocGenerator.js`)
- JSDoc generator → JSDoc rendering plugin: uses rendering plugin
- OpenAPI generator → Generator base: extends generator (evidence: `lib/generators/openapi/OpenAPIGenerator.js`)
- OpenAPI generator → OpenAPI Markdown renderer: renders Markdown (evidence: `lib/generators/openapi/OpenAPIGenerator.js`)
- OpenAPI Markdown renderer → OpenAPI render helpers: uses helpers (evidence: `lib/generators/openapi/openapi2md/dmd/helpers/helpers.js`)
- OpenAPI render helpers → HTML description parser: parses descriptions (evidence: `lib/generators/openapi/openapi2md/dmd/helpers/helpers.js`)
- HTML description parser → HTML node factory: creates nodes (evidence: `lib/generators/openapi/html/HTMLParser.js`)
- JSDoc generator → Safe filesystem: writes generated pages (evidence: `lib/generators/jsdoc/JSDocGenerator.js`)
- OpenAPI generator → Safe filesystem: reads and writes files (evidence: `lib/generators/openapi/OpenAPIGenerator.js`)
- Generator base → Path cache: stores source paths (evidence: `lib/generators/base/BaseGenerator.js`)
- Generator base → Safe filesystem: checks source paths (evidence: `lib/generators/base/BaseGenerator.js`)
- Docsify site setup → Safe filesystem: writes site files (evidence: `lib/docsify/index.js`)
- Release note renderer → Site templates: uses templates (evidence: `lib/releases/index.js`)
