Skip to content

emolr/gitbook-plugin-jsdoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

A jsdoc filter to inject jsdoc in gitbook

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published