Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcusolsson/dts-docs
A command-line tool for generating Markdown documentation from .d.ts.
https://github.com/marcusolsson/dts-docs
Last synced: 3 months ago
JSON representation
A command-line tool for generating Markdown documentation from .d.ts.
- Host: GitHub
- URL: https://github.com/marcusolsson/dts-docs
- Owner: marcusolsson
- License: mit
- Created: 2021-10-10T16:04:08.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T10:15:59.000Z (8 months ago)
- Last Synced: 2024-04-30T12:39:47.407Z (7 months ago)
- Language: TypeScript
- Size: 390 KB
- Stars: 12
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://marcus.se.net/obsidian-plugin-docs/).
**IMPORTANT:** This is **NOT** fit for production use. Use at your own risk.
## Usage
```bash
yarn install
yarn generate --input ./definitions.d.ts --output ./docs
```