A documentation generator for Typescript-based libraries with good support for monorepos
- node >15.0.0
npm install --global fliegdoc
$ fliegdoc --help
Usage: fliegdoc [command] [options]
Commands:
fliegdoc build [options] Build the documentation [default] [aliases: b]
fliegdoc serve [options] Preview the documentation in the browser[aliases: s]
fliegdoc completion generate completion script
Options:
--help Show help [boolean]
-s, --serve Serve the static files after build [boolean] [default: false]
-p, --port The port on which the documentation gets hosted [number]
-v, --version Show version number [boolean]
Get help for individual commands by running fliegdoc <command> --help
The CLI searches for a fliegdoc.config.js
file and applies its options on top of the default options.
// fliegdoc.config.js
const { HTMLTheme } = require('fliegdoc');
module.exports = {
baseUrl: '/',
outDir: './docs',
readme: './README.md',
modules: [
{
package: './package.json',
tsconfig: './tsconfig.json',
mainFile: 'main.ts'
}
],
title: 'Documentation', // appears in the page title and header
externalLinks: {}, // e.g.: { "GitHub": "https://github.com/fliegwerk/fliegdoc" }
hidePrivateMembers: true,
theme: HTMLTheme
};
import {} from 'fliegdoc';
(cf. docs for a list of exported members)
Themes take the doc-ready AST and configuration and write a resulting file structure.
Detailed guides on creating themes will follow soon.
👤 Pablo Klaschka
- Twitter: @pklaschka2000
- Github: @pklaschka
- LinkedIn: @pklaschka
Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.
Give a ⭐️ if this project helped you!
Copyright © 2021 Pablo Klaschka.
This project is MIT licensed.
This README was generated with ❤️ by readme-md-generator