This project is the next generation documentation generator for JavaScript-based languages. Right now, it is work-in-progress and supports enough features to generate the PixiJS documentation.
You can checkout the documentation for example/ here!
npm install -g @webdoc/cliTo get started, create a webdoc.conf.json file in your project directory.
{
"includePattern": "src/**/*.js",
"plugins": [
],
"opts": {
"destination": "docs"
}
}The only required field is includePattern which tells webdoc where the documented code is located at.
You can now run webdoc in your terminal and documentation will be generated.
| Packages | npm | |
|---|---|---|
| @webdoc/cli |  |
 |
| @webdoc/model |  |
 |
| @webdoc/types |  |
 |
| @webdoc/parser |  |
 |
| @webdoc/externalize |  |
 |
| @webdoc/template-library |  |
 |
| @webdoc/legacy-template |  |
 |
| @webdoc/default-template | Coming soon! | Coming soon! |
-
Support for JavaScript, Flow, and TypeScript. The modular structure of @webdoc/parser allows you to integrate it with other languages as well.
-
High-performance document tree that enforces proper relationships between symbols.
-
Importing external APIs to integrate your documentation
Coming soon:
-
Documentation coverage analysis
-
Powerful default template that:
- integrates with JSFiddle & CodePen for live examples of your API
- provides a neat and clean navigation for users
- makes it easy to write tutorials
Glad you asked! Open an issue and I'll get you something to work on! webdoc has an amazing potential to disrupt the stagnated documentation process!