gitbook-plugin-jsdoc
A jsdoc filter to inject jsdoc in gitbook.
Last updated 3 years ago by emolr .
Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install gitbook-plugin-jsdoc 
SYNC missed versions from official npm registry.

jsdoc in gitbook

With this plugin a book can contain jsdoc from a specified Javascript file.

How to use it?

To use the jsdoc plugin in your Gitbook project, add the jsdoc plugin to the book.json file, then install plugins using gitbook install.

{
    "plugins": ["jsdoc"]
}

jsdoc format

To inject a full jsdoc documentation to a page, add this snippet in the markdown file.

{{ "/absolute/path/to/js/file.js" | jsdoc }}

Current Tags

  • 0.0.6                                ...           latest (3 years ago)

6 Versions

  • 0.0.6                                ...           3 years ago
  • 0.0.5                                ...           3 years ago
  • 0.0.4                                ...           3 years ago
  • 0.0.3                                ...           3 years ago
  • 0.0.2                                ...           3 years ago
  • 0.0.1                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 2
Last Day 0
Last Week 1
Last Month 3
Dependencies (1)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |