Dockit

| Package | Link | | :-------------------- | :------------------------------------------------------------------------------------------------------------------------- | | dockit-cli (.NET CLI) | | | dockit-cli (NPM CLI) | |

What is this?

Dockit is an automatic Markdown documentation generator. This repository contains:

• a .NET generator for assemblies and XML documentation metadata
• a TypeScript generator for npm projects using the TypeScript compiler API

The advantage of Dockit is that it generates the document once in Markdown format and then uses Pandoc to generate the document from Markdown. This allows you to target a variety of output formats.

It is also much simpler to manage than other solutions, as you simply install NuGet and it automatically generates the documentation for you.

Install

TypeScript / JavaScript

Install the NPM package via npmjs:

npm install -g dockit-cli

Usage

TypeScript / JavaScript

The TypeScript generator accepts a package root path and an output directory:

dockit-ts [options] <project-path> <output-directory>

Available options:

• -h, --help: Show usage help.
• -l VALUE, --initial-level=VALUE: Set the base heading level of the generated Markdown. The default is 1.
• -e VALUE, --entry=VALUE: Add a source entry point. Can be specified multiple times.
• --with-metadata=PATH: Read only the leading Markdown metadata table from the specified package.json.
• --no-hash-link: Do not emit local hash links to other items in the generated Markdown. Other links remain unchanged.

Generate Markdown from an npm package:

dockit-ts ./path/to/package ./docs/api

This writes ./docs/api/<package-name>.md.

Successful runs print the resolved input and output paths:

Input project: /absolute/path/to/package
Output markdown: /absolute/path/to/docs/api/<package-name>.md
Elapsed time: 123.456 ms

Generate Markdown from a CLI-style package that keeps source files under src:

dockit-ts --entry ./src/index.ts ./path/to/package ./docs/api

Documents

For more information, please visit repository and refer README: Dockit

License

Copyright (c) Kouji Matsui (@[email protected])

License under Apache-v2.