How barchart/documentation-generator works
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: cli.js Command interface · generateDocs.js Generate docs · generateReleases.js Generate releases · index.js Docsify site setup
Components 23
CLI commands
- Command interface
bin/cli.js - Generate docs
lib/commands/generateDocs.js - Initialize docs
lib/commands/initDocs.js - Generate releases
lib/commands/generateReleases.js - Cache manager
lib/commands/cacheManager.js - Clear cache
lib/commands/clearCache.js - Serve site
lib/commands/serveDocs.js
Site content
- Docsify site setup
lib/docsify/index.js - Site templates
lib/templates/index.js
Content generators
- JSDoc generator
lib/generators/jsdoc/JSDocGenerator.js - JSDoc rendering plugin
lib/generators/jsdoc/dmd-plugin/helper/helpers.js - OpenAPI generator
lib/generators/openapi/OpenAPIGenerator.js - OpenAPI Markdown renderer
lib/generators/openapi/openapi2md/dmd/index.js - HTML description parser
lib/generators/openapi/html/HTMLParser.js - HTML node factory
lib/generators/openapi/html/NodeFactory.js - OpenAPI render helpers
lib/generators/openapi/openapi2md/dmd/helpers/helpers.js - Generator base
lib/generators/base/BaseGenerator.js - Release note renderer
lib/releases/index.js
Shared services
- Project metadata
lib/common/projectMeta/ProjectMeta.js - Generator options
lib/common/options/Options.js - Path cache
lib/common/cache/index.js - Safe filesystem
lib/common/fsSafe/index.js
Other components
- Documentation author
Connections 36
- Documentation author → Command interface: runs commands
README.md - Command interface → Generate docs: dispatches generate
bin/cli.js - Command interface → Initialize docs: dispatches init
bin/cli.js - Command interface → Generate releases: dispatches releases
bin/cli.js - Command interface → Clear cache: dispatches clear-cache
bin/cli.js - Command interface → Cache manager: dispatches cache
bin/cli.js - Command interface → Serve site: dispatches serve
bin/cli.js - Generate docs → Project metadata: loads metadata
lib/commands/generateDocs.js - Generate docs → Generator options: creates options
lib/commands/generateDocs.js - Generate docs → Docsify site setup: initializes site
lib/commands/generateDocs.js - Generate docs → JSDoc generator: runs generator
lib/commands/generateDocs.js - Generate docs → OpenAPI generator: runs generator
lib/commands/generateDocs.js - Generate docs → Generate releases: generates releases
lib/commands/generateDocs.js - Initialize docs → Docsify site setup: initializes site
lib/commands/initDocs.js - Initialize docs → Generate releases: generates releases
lib/commands/initDocs.js - Generate releases → Project metadata: loads metadata
lib/commands/generateReleases.js - Generate releases → Release note renderer: renders notes
lib/commands/generateReleases.js - Generate releases → Site templates: registers templates
lib/commands/generateReleases.js - Cache manager → Project metadata: loads metadata
lib/commands/cacheManager.js - Cache manager → Path cache: reads and updates
lib/commands/cacheManager.js - Clear cache → Path cache: clears saved paths
lib/commands/clearCache.js - Serve site → Docsify site setup: serves site
lib/commands/serveDocs.js - Docsify site setup → Site templates: compiles site pages
lib/docsify/index.js - JSDoc generator → Generator base: extends generator
lib/generators/jsdoc/JSDocGenerator.js - JSDoc generator → JSDoc rendering plugin: uses rendering plugin
- OpenAPI generator → Generator base: extends generator
lib/generators/openapi/OpenAPIGenerator.js - OpenAPI generator → OpenAPI Markdown renderer: renders Markdown
lib/generators/openapi/OpenAPIGenerator.js - OpenAPI Markdown renderer → OpenAPI render helpers: uses helpers
lib/generators/openapi/openapi2md/dmd/helpers/helpers.js - OpenAPI render helpers → HTML description parser: parses descriptions
lib/generators/openapi/openapi2md/dmd/helpers/helpers.js - HTML description parser → HTML node factory: creates nodes
lib/generators/openapi/html/HTMLParser.js - JSDoc generator → Safe filesystem: writes generated pages
lib/generators/jsdoc/JSDocGenerator.js - OpenAPI generator → Safe filesystem: reads and writes files
lib/generators/openapi/OpenAPIGenerator.js - Generator base → Path cache: stores source paths
lib/generators/base/BaseGenerator.js - Generator base → Safe filesystem: checks source paths
lib/generators/base/BaseGenerator.js - Docsify site setup → Safe filesystem: writes site files
lib/docsify/index.js - Release note renderer → Site templates: uses templates
lib/releases/index.js