v0.0.1

Introducing...

Documentalist

Documentalist is a library for parsing documentation from CSS,
Typescript, and Markdown files. The output is a well-formed JSON object
that can be fed directly into any number of static site generators.

Command Line

Install:

npm install documentalist

Create some documentation data:

documentalist 'src/**/*' > docs.json

API

Of course, you can also use Documentalist in a Node.js environment like so:

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

const dm = new Documentalist();
const docs = dm.documentGlobs("src/**/*");

writeFileSync("docs.json", JSON.stringify(docs, null, 2));

Plugins

Documentalist uses a plugin architecture to support arbitrary file types.