Browse Source

Refactor options instructions in README

Rob McGuinness 7 years ago
parent
commit
11ee57acdb
1 changed files with 16 additions and 14 deletions
  1. 16 14
      README.md

+ 16 - 14
README.md

@@ -21,10 +21,12 @@ Add the plugin to your `book.json`, and disable default GitBook code highlightin
 
 ## Options
 
+
+### `css`
 Override default styles.  All css files must reside in the same folder.
 
 ```json
-"pluginsConfig": {  
+"pluginsConfig": {
   "prism": {
     "css": [
       "prismjs/themes/prism-solarizedlight.css"
@@ -33,6 +35,19 @@ Override default styles.  All css files must reside in the same folder.
 }
 ```
 
+### `lang`
+Support non-standard syntax prefixes by aliasing existing prefixes.
+
+```json
+"pluginsConfig": {
+  "prism": {
+    "lang": {
+      "flow": "typescript"
+    }
+  }
+}
+```
+
 ### Prism Themes
 
 [https://github.com/PrismJS/prism](https://github.com/PrismJS/)
@@ -65,19 +80,6 @@ Override default styles.  All css files must reside in the same folder.
 #### Xonokai <small>`syntax-highlighting/assets/css/prism/prism-xonokai.css`</small>
 ![Google Light](http://i.imgur.com/fPjEEv8.png)
 
-### Syntax aliasing
-
-To support non-standard syntax prefixes, you can alias existing prefixes:
-```json
-"pluginsConfig": {  
-  "prism": {
-    "lang": {
-      "flow": "typescript"
-    }
-  }
-}
-```
-
 ## Credits
 
 Originally based on https://github.com/spricity/google_code_prettify.