0.0.20 • Published 5 years ago
tsdoc2md v0.0.20
tsdoc2md
convert typescript comments to markdown file.
Comments converting of Class, Property, Constructor and Method is implemented. More will come up soon.
Only support annotations @param, @returns, @example.
Please follow typescript doc comment syntax: Doc comment syntax
Demo
Install
npm install -g tsdoc2md
Usage
step1
generate config file named 'tsdoc2md.json'
// tsdoc2md.json
{
"entry": {
"README": "/lib/index.d.ts"
},
"outDir": "/docs/"
}
/**
* 1. key of entry will be name of markdown file.
* 2. entry file should be a declaration file.
*/
your tsconfig shoud be:
// tsconfig.json
{
...
"declaration": true,
"declarationMap": true,
"outDir": "lib"
...
}
step2
execute command
# use in terminal
tsdoc2md
0.0.20
5 years ago
0.0.19
5 years ago
0.0.18
5 years ago
0.0.17
5 years ago
0.0.16
5 years ago
0.0.15
5 years ago
0.0.14
5 years ago
0.0.13
5 years ago
0.0.12
5 years ago
0.0.11
5 years ago
0.0.10
5 years ago
0.0.9
5 years ago
0.0.8
5 years ago
0.0.7
5 years ago
0.0.6
5 years ago
0.0.5
5 years ago
0.0.4
5 years ago
0.0.3
5 years ago
0.0.2
5 years ago
0.0.1
5 years ago