Browse Source

Add doc in readme to disable highlight

Samy Pessé 8 years ago
parent
commit
9a073d41ce
2 changed files with 4 additions and 4 deletions
  1. 3 3
      README.md
  2. 1 1
      package.json

+ 3 - 3
README.md

@@ -1,7 +1,7 @@
 Gitbook Plugin for [Prism](http://prismjs.com/)
 ==============
 
-Currently only supports JavaScript.  
+Currently only supports JavaScript.
 Pull requests to fix this are welcome.
 
 <table>
@@ -25,11 +25,11 @@ Pull requests to fix this are welcome.
 
 ## Usage
 
-Add the plugin to your `book.json`:
+Add the plugin to your `book.json`, and disable default GitBook code highlighting:
 
 ```
 {
-  "plugins": ["prism"]
+  "plugins": ["prism", "-highlight"]
 }
 ```
 

+ 1 - 1
package.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "version": "0.1.1",
   "engines": {
-    "gitbook": ">=2.4.0"
+    "gitbook": ">=2.4.1"
   },
   "homepage": "https://github.com/gaearon/githook-plugin-prism",
   "repository": {