https://github.com/t99/harbour
Generate documentation from TypeScript files (with JSDoc comments) in a Markdown format to be used with mkdocs.
https://github.com/t99/harbour
documentation documentation-generation documentation-generator generate-documentation jsdoc jsdocs
Last synced: 17 days ago
JSON representation
Generate documentation from TypeScript files (with JSDoc comments) in a Markdown format to be used with mkdocs.
- Host: GitHub
- URL: https://github.com/t99/harbour
- Owner: T99
- License: gpl-3.0
- Created: 2021-08-25T16:41:31.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-05T20:46:42.000Z (over 4 years ago)
- Last Synced: 2025-03-02T21:34:21.925Z (about 1 year ago)
- Topics: documentation, documentation-generation, documentation-generator, generate-documentation, jsdoc, jsdocs
- Language: TypeScript
- Homepage: https://T99.github.io/harbour/
- Size: 34.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Harbour
Generate documentation from TypeScript files (with JSDoc comments) in a Markdown format to be used with mkdocs.
### [Find @t99/harbour on NPM.](https://www.npmjs.com/package/@t99/harbour)
## Table of Contents
- [Installation](#installation)
- [Basic Usage](#basic-usage)
- [Documentation](#documentation)
- [License](#license)
## Installation
Install from NPM with
```
$ npm install --save @t99/harbour
```
## Basic Usage
Basic usage instructions here.
## Documentation
See the [wiki](https://github.com/T99/harbour/wiki) for full documentation.
## License
harbour is made available under the GNU General Public License v3.
Copyright (C) 2021 Trevor Sears