A sort-of-static site generator optimized for living documentation of software projects.
- documentation should live with code
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 } = require("documentalist");
const { writeFileSync } = require("fs");
const docs = new Documentalist()
.use(".md", new MarkdownPlugin())
.documentGlobs("src/**/*");
writeFileSync("docs.json", JSON.stringify(docs, null, 2));
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
This project is made available under the BSD License and includes a Patent Grant.