https://github.com/11ways/protodoc
A documentation generator for your JavaScript code
https://github.com/11ways/protodoc
Last synced: 11 months ago
JSON representation
A documentation generator for your JavaScript code
- Host: GitHub
- URL: https://github.com/11ways/protodoc
- Owner: 11ways
- License: mit
- Created: 2021-03-29T16:07:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-29T12:16:16.000Z (almost 5 years ago)
- Last Synced: 2025-06-30T15:50:58.557Z (about 1 year ago)
- Language: JavaScript
- Size: 63.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
protodoc
📚 A documentation generator for your JavaScript code
## Introduction
This repository contains a personal skeleton that I use when I publish my [npm packages](https://www.npmjs.com/~skerit).
## Install
```bash
npm install protodoc
```
## Usage
```js
const Protodoc = require('protodoc');
```
## Contributing
Contributions are REALLY welcome.
Please check the [contributing guidelines](.github/contributing.md) for more details. Thanks!
## Authors
- **Jelle De Loecker** - *Follow* me on *Github* ([:octocat:@skerit](https://github.com/skerit)) and on *Twitter* ([🐦@skeriten](http://twitter.com/intent/user?screen_name=skeriten))
See also the list of [contributors](https://github.com/11ways/protodoc/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/11ways/protodoc/LICENSE) file for details.