Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/halogenica/beautifulhugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Romero <angelkatalyst@gmail.com>2017-02-12 15:26:35 +0300
committerMichael Romero <angelkatalyst@gmail.com>2017-02-12 15:26:35 +0300
commit938766f54f6e8cf3ec7c175606ac7511a4cfd1c9 (patch)
treea9907cbc75f3ed6533bac36cbcab7c04ffa96c97 /README.md
parent2f1a27dc9583c2b7bb7feddc09de372df06ee43f (diff)
Add client side syntax highlighting support
Added client side syntax highlighting support in addition to existing server side syntax highlighting support. Updated readme and sample to reflect both types of highlighting.
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 04c124f..7b20138 100644
--- a/README.md
+++ b/README.md
@@ -18,11 +18,21 @@ This theme is designed to look great on both large-screen and small-screen (mobi
### Syntax highlighting
-This theme has support for `highlight` shortcode (with Pygments),
+This theme has support for both server side and client side highlighting.
+
+#### Server side syntax highlighting
+
+Use the `highlight` shortcode (with Pygments),
see [the Hugo documentation](http://gohugo.io/extras/highlighting/) for more information.
To use this feature install Pygments (`pip install Pygments`) and add `pygmentsuseclasses = true` to your `config.toml`.
+#### Client side syntax highlighting
+
+Use triple backticks "```" or triple tilde "~~~" around code blocks.
+
+Client side highlighting does not require pygments to be installed.
+
### Disqus support
To use this feature, uncomment and fill out the `disqusShortname` parameter in `config.toml`.