marcusolsson / dts-docs

A command-line tool for generating Markdown documentation from .d.ts.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DTS Docs

A command-line tool for generating Markdown documentation for a .d.ts file.

This tool is used to generate the API reference documentation for the unofficial plugin development guide for Obsidian.

IMPORTANT: This is NOT fit for production use. Use at your own risk.

Usage

yarn install
yarn generate --input ./definitions.d.ts --output ./docs

About

A command-line tool for generating Markdown documentation from .d.ts.

License:MIT License


Languages

Language:TypeScript 98.0%Language:JavaScript 2.0%