Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

gitbook-plugin-jsdoc

0.0.6 • Public • Published

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 }}

Keywords

none

Install

npm i gitbook-plugin-jsdoc

DownloadsWeekly Downloads

2

Version

0.0.6

License

none

Unpacked Size

1.88 kB

Total Files

3

Last publish

Collaborators

  • avatar