-
Notifications
You must be signed in to change notification settings - Fork 9
webdoc monorepo
Sukant Pal edited this page Apr 23, 2020
·
1 revision
webdoc is a documentation generator for JavaScript-based languages.
- Parsing JavaScript(-based) files into a documentation tree.
- Creating a documentation site using a template (a default template comes built-in).
- Linking external API types to their documentation site.
-
@webdoc/types: The doc & tag types used in the webdoc model.
-
@webdoc/model: This is the doclet API for webdoc. It consists utility functions to modify the doc-tree.
-
@webdoc/parser: The parser transforms JavaScript(-based) files into a doc-tree.
-
@webdoc/generator: The generator traverses the doc-tree to output a HTML file for each containing scope based on a template.
-
@webdoc/doc-schema: This generates a XML file that contains all the types documented in the doc-tree. It is used to find where external APIs are documented.
-
@webdoc/cli: The CLI package will support:
- loading the configuration for the parser & generator.
- running the doc-schema package
- running the generator
- binding plugins