/webdoc

Documentation generator for the web

Primary LanguageJavaScriptMIT LicenseMIT

Logo-Frame

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

npm install -g @webdoc/cli

To get started, create a webdoc.conf.json file in your project directory.

{
  "includePattern": ["src/**/*.js"],
  "plugins": [
    "plugins/markdown"
  ],
  "opts": {
    "destination": "docs"
  },
  "template": {
    "repository": "<your_github_url>",
    "outputSourceFiles": false
  }
}

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

Packages npm
@webdoc/cli npm David (path)
@webdoc/model npm David (path)
@webdoc/types npm David (path)
@webdoc/parser npm David (path)
@webdoc/externalize npm David (path)
@webdoc/template-library npm David (path)
@webdoc/legacy-template npm David (path)
@webdoc/default-template npm David (path)

Features

  • 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

Development Roadmap

Contribute

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!