v0.0.7

• isolate client typings in separate files to avoid attempting to include compile-time libraries in a browser environment #29

v0.0.6

• new options for TypescriptPlugin and Documentalist #27
• swap order of Documentalist constructor args so options comes first
• ⚠️ remove default plugins from Documentalist.create() because they now have options that will likely want to be set

v0.0.5

• MarkdownPlugin generates nav layout tree #19
• MarkdownPlugin populates route property on all pages and headings #20
• a bunch of API refactors: INavigable, more use of IBlock #21

v0.0.4

• new renderMarkdown method in ICompiler renders a string of markdown to HTML using options from Documentalist #16

v0.0.3

Major changes

• 🌟 new KssPlugin exposes KSS markup/modifier examples. #14
• ❌ removed postcss-based CssPlugin #14
• 🎱 Documentalist#use() evolves the type of output data as new plugins are added! #9

Other updates

• Plugins may now be asynchronous #10
• Upgraded Typescript to 2.2 and TSLint to 4.5 #11
• All plugins return maps instead of arrays for easier lookup by name #12
• Better separation of top-level API (Documentalist) and methods used by plugins (Compiler) #13

v0.0.2

Patch Fix

Fix .npmignore so that the cli is included in the published artifacts.

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.