Skip to content

Commit c7eba5c

Browse files
committed
Add README.md
1 parent 86ab5c3 commit c7eba5c

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# DTS Docs
2+
3+
A command-line tool for generating Markdown documentation for a `.d.ts` file.
4+
5+
This tool is used to generate the API reference documentation for the unofficial [plugin development guide for Obsidian](https://marcus.se.net/obsidian-plugin-docs/).
6+
7+
**IMPORTANT:** This is **NOT** fit for production use. Use at your own risk.
8+
9+
## Usage
10+
11+
```bash
12+
yarn install
13+
yarn generate --input ./definitions.d.ts --output ./docs
14+
```

0 commit comments

Comments
 (0)