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

github.com/parsiya/Hugo-Octopress.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorparsiya <parsiya@gmail.com>2018-04-15 12:57:01 +0300
committerparsiya <parsiya@gmail.com>2018-04-15 12:57:01 +0300
commite97f9ec8822195d9484a28e16f3320b3834ef37c (patch)
tree777a6c817455add89e9415844a1722cc72fdccd6 /README.md
parentf0407eaca1707420ef6a95cf6daf6fbae9d9750d (diff)
Add support for Chroma highlight, remove old CSS and update codecaption to work with Chroma highlighting
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 8 insertions, 19 deletions
diff --git a/README.md b/README.md
index 566ba71..0636d10 100644
--- a/README.md
+++ b/README.md
@@ -108,36 +108,25 @@ post = "/blog/:year-:month-:day-:title/"
```
## <a name="highlight"></a>Code highlight
-Octopress classic theme uses the pygments' `solarized dark` for highlighting. It is not installed by default. You can get it from https://github.com/john2x/solarized-pygment. It has three options:
-
-* solarized_light: default option after installation
-* solarized_dark: use this to re-create the Octopress classic theme highlighting
-* solarized_dark256
-
-As on Hugo 0.28 the built-in Chroma highlighter is used by default. It does not support solarized dark yet. To keep using the highlighting by CSS add `pygmentsUseClassic=true` to the config file.
+The theme now supports the built-in Chroma highlighter. However, Chroma does not support the pygments `solarized dark` style. It's added to the CSS instead and must be enabled with `pygmentsuseclasses = true` in the config file. To use the Chroma highlighter, you need to disable Pygments with `pygmentsUseClassic=false`.
The following options control code highlighting:
``` toml
-[params]
- # If nothing is set, then solarized_light is used
- pygmentsstyle = "solarized_dark"
+# Highlight shortcode and code fences (```) will be treated similarly
+pygmentscodefences = true
- # Use internal highlighter instead of Chroma
- pygmentsUseClassic=true
+# Use CSS for highlighting
+pygmentsuseclasses = true
- # Highlight shortcode and code fences (```) will be treated similarly
- pygmentscodefences = true
-
- # pygments options can be added here (and in the highlight shortcode in the markdown file)
- # Hugo supports these pygments options: style, encoding, noclasses, hl_lines, linenos
- # for example: pygmentsoptions = "linenos=true"
+# pygments options can be added here (and in the highlight shortcode in the markdown file)
+# Hugo supports these pygments options: style, encoding, noclasses, hl_lines, linenos
+# for example: pygmentsoptions = "linenos=true"
```
For more information see [Syntax Highlighting](https://gohugo.io/extras/highlighting/) in Hugo's documentation.
## <a name="markdown"></a>Markdown options
-
Blackfriday is Hugo's markdown engine. For a list of options see [Configure Blackfriday rendering](https://gohugo.io/overview/configuration/#configure-blackfriday-rendering). Blackfriday options can be set as follows:
``` toml