Description
This project is the next generation documentation generator for JavaScript-based languages, including Flow and TypeScript!
webdoc alternatives and similar modules
Based on the "Documentation" category.
Alternatively, view webdoc alternatives based on common mentions on social networks and blogs.
SaaSHub - Software Alternatives and Reviews
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of webdoc or a related project?
Popular Comparisons
README
© 2020-2022 webdoc Labs
webdoc Example documentation
webdoc is the next generation documentation generator for the family of web languages. It supports the JSDoc notation and infers type data from TypeScript definitions.
You can checkout the documentation for example/ here!
Usage :newspaper_roll:
npm install --save-dev @webdoc/cli
To get started, create a webdoc.conf.json file in your project directory.
{
"source": {
"include": "src/",
"excludePattern": "(node_modules|lib|test)"
},
"plugins": [
"plugins/markdown"
],
"opts": {
"destination": "docs"
},
"template": {
"repository": "<your_github_url>",
"outputSourceFiles": false
}
}
The only required field is source.include which tells webdoc where the source files are. [@webdoc/cli](packages/webdoc-cli)'s README details more configuration options
You can now run webdoc in your terminal and documentation will be generated. Be sure to serve the documentation from the folder it is generated in. If you need to serve from an ancestor directory, provide the documentation path relative to the root using the --site-root option, e.g. webdoc --site-root docs.
Features :tada:
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