diff --git a/readme.txt b/readme.txt index 7c1c18f..74a8b23 100644 --- a/readme.txt +++ b/readme.txt @@ -119,7 +119,7 @@ To restore default plugin options, either uninstall/reinstall the plugin or visi -** Usage: Syntax Highlighting** +**Usage: Syntax Highlighting** The Prismatic plugin follows the same conventions used by [Prism.js](http://prismjs.com/) and [Highlight.js](https://highlightjs.org/). Here are the basic steps: @@ -129,8 +129,13 @@ The Prismatic plugin follows the same conventions used by [Prism.js](http://pris Once the settings are configured, you can enable syntax highlighting for any code snippet by doing one of the following: -* Wrap multi-line code with pre & code tags: `
...
`
-* Wrap single-line code with code tags: `...
` (Prism.js only)
+__Wrap multi-line code with pre & code tags:__
+
+ ...
+
+__Wrap single-line code with code tags:__ (Prism.js only)
+
+ ...
With the proper markup in place, you can indicate a specific language by adding a class of `language-***` or `lang-***` to the `` tag (where `***` is the language identifier).
@@ -160,15 +165,21 @@ __Note:__ In addition to detecting the `language-` and `lang-` prefixes, Highlig
-** Usage: Code escaping**
+**Usage: Code escaping**
Just like Prism.js and Highlight.js, the Prismatic plugin follows HTML coding standards. To enable code escaping:
1. Visit the Prismatic General Settings and choose your library
2. Enable "Code Escaping" via the settings tab of your chosen library
3. Do one of the following:
- * Wrap single-line code with code tags: `...
`
- * Wrap multi-line code with pre & code tags: `...
`
+
+__Wrap single-line code with code tags:__
+
+ ...
+
+__Wrap multi-line code with pre & code tags:__
+
+ ...
For example, the code snippets included in either of the following markup examples would be escaped: