Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
gitbook-plugin-clojurescript
Advanced tools
gitbook-plugin-clojurescript - npm Package Compare versions
Comparing version 0.0.5 to 0.0.6
@@ -5,3 +5,3 @@ { | ||
| "main": "index.js", | ||
| "version": "0.0.5", | ||
| "version": "0.0.6", | ||
| "engines": { | ||
@@ -8,0 +8,0 @@ "gitbook": "*" |
@@ -1,98 +0,9 @@ | ||
| GitBook Sample Plugin | ||
| GitBook Plugin For ClojureScript | ||
| ============== | ||
| This is a sample plugin for GitBook. | ||
| This is Gitbook Plugin for ClojureScript. | ||
| Install it using: ```$ npm install gitbook-plugin``` | ||
| ## How GitBook plugin works? | ||
| A plugin for GitBook is a node package that can be published on [NPM](http://www.npmjs.org). | ||
| ### package.json | ||
| #### name | ||
| The package name should begin with ```gitbook-plugin-```. And if your plugin is a theme, it should begin with ```gitbook-theme-```. | ||
| Examples: `gitbook-plugin-mixpanel`, `gitbook-plugin-googleanalytics`, `gitbook-theme-dark` | ||
| #### engine | ||
| The package.json should contain a `engine` field using [the standard norm](https://www.npmjs.org/doc/json.html#engines). | ||
| ### Usage | ||
| ``` | ||
| "engines": { | ||
| "gitbook": "*" | ||
| } | ||
| { "plugins": ["clojurescript"] } | ||
| ``` | ||
| For example if you want your plugin to supports only GitBook version supperior to 0.3.1: | ||
| ``` | ||
| "engines": { | ||
| "gitbook": ">=0.3.1" | ||
| } | ||
| ``` | ||
| ### entry point | ||
| The plugin entry point should return an object with some metadata. | ||
| #### "book" | ||
| Type: `Object` | ||
| Default value: `{}` | ||
| #### "book.assets" | ||
| Type: `String` | ||
| Default value: `null` | ||
| Path to the assets folder to copy | ||
| #### "book.js" | ||
| Type: `Array` | ||
| Default value: `[]` | ||
| List of javascript file to add to the html pages (relative to the assets folder). | ||
| #### "book.css" | ||
| Type: `Array` | ||
| Default value: `[]` | ||
| List of css file to add to the html pages (relative to the assets folder). | ||
| #### "book.html" | ||
| Type: `Object` | ||
| Default value: `{}` | ||
| Map of position -> code, html snippets to add to each page. The code could be a function. | ||
| #### "book.templates" | ||
| Type: `Object` | ||
| Default value: `{}` | ||
| Templates to override default templates, only use this option if you want to change entirely how the book is rendered. | ||
| This object is a map: "name" -> "file", with names: | ||
| * "site": page for a file from the `site` format | ||
| * "page": page for the `page` format | ||
| #### "hooks" | ||
| Type: `Object` | ||
| Default value: `{}` | ||
| Map of "name" -> Function that needs to be called during build process. With names: | ||
| * "init": just after initialization, before generation | ||
| * "finish": after generation and everything is finished | ||
| Each hook can return a promise. | ||
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Lines of code
- increased by0.03%
20051
Worsened metrics
- Total package byte prevSize
- decreased by-0.24%
781369
- Number of lines in readme file
- decreased by-89.9%
10
No dependency changes