documentalist

Documentalist

A sort-of-static site generator optimized for living documentation of software projects.

Documentalism 101

• documentation should live with code

Usage

Documentalist comes pre-configured with support for the following languages:

• .md files for longform documentation and overall structure
• .ts, .tsx files for JSDoc comments on interfaces in TypeScript source code
• .css, .less, .scss files for comments on CSS selectors

With the JavaScript API, nothing comes for free. All plugins must be registered with .use().

const { Documentalist, MarkdownPlugin, TypescriptPlugin } = require("documentalist");
const { writeFileSync } = require("fs");

new Documentalist()
  .use(".md", new MarkdownPlugin())
  .use(/\.tsx?$/, new TypescriptPlugin({ excludeNames: [/I.+State$/] }))
  .documentGlobs("src/**/*")
  .then(docs => JSON.stringify(docs, null, 2))
  .then(json => writeFileSync("docs.json", json))

With the CLI, the Markdown and Typescript plugins are enabled by default. The CSS plugin can be enabled with --css.

documentalist "src/**/*" --css --no-ts > docs.json

License

This project is made available under the BSD License and includes a Patent Grant.