https://github.com/webdoc-labs/webdoc

Documentation generator for the web
https://github.com/webdoc-labs/webdoc

documentation-generator jsdoc-comments nodejs webdoc

Last synced: about 1 year ago
JSON representation

Documentation generator for the web

• Host: GitHub
• URL: https://github.com/webdoc-labs/webdoc
• Owner: webdoc-labs
• License: other
• Created: 2020-04-19T01:49:01.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-27T12:59:36.000Z (over 1 year ago)
• Last Synced: 2024-10-30T04:13:16.418Z (over 1 year ago)
• Topics: documentation-generator, jsdoc-comments, nodejs, webdoc
• Language: JavaScript
• Homepage: https://www.webdoclabs.com
• Size: 5.81 MB
• Stars: 79
• Watchers: 3
• Forks: 9
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

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](https://webdoc-labs.github.io/example-documentation/index.html)!

## Usage :newspaper_roll:

```shell

npm install --save-dev @webdoc/cli

```

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

```json

{

  "source": {

    "include": "src/",

    "excludePattern": "(node_modules|lib|test)"

  },

  "plugins": [

    "plugins/markdown"

  ],

  "opts": {

    "destination": "docs"

  },

  "template": {

    "repository": "",

    "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