Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/discordjs/docgen
The docs.json generator for discord.js and its related projects
https://github.com/discordjs/docgen
discord discordjs docgen docs documentation generator hacktoberfest jsdoc
Last synced: 3 months ago
JSON representation
The docs.json generator for discord.js and its related projects
- Host: GitHub
- URL: https://github.com/discordjs/docgen
- Owner: discordjs
- License: apache-2.0
- Archived: true
- Created: 2016-11-21T05:11:59.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-04-17T09:33:08.000Z (over 2 years ago)
- Last Synced: 2024-04-13T21:55:12.934Z (9 months ago)
- Topics: discord, discordjs, docgen, docs, documentation, generator, hacktoberfest, jsdoc
- Language: JavaScript
- Homepage:
- Size: 142 KB
- Stars: 64
- Watchers: 8
- Forks: 25
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# discord.js-docgen
This is the application that generates the `docs.json` files for [discord.js](https://github.com/discordjs/discord.js) and
[discord.js-commando](https://github.com/discordjs/Commando). It parses all JSDocs in any given directories, and outputs
a single JSON file with data about all classes, properties, methods, typedefs, etc. It also accepts custom docs files.
This is handy for documentation websites, so that they can load the data dynamically and display it however they need.