aboutsummaryrefslogtreecommitdiff
path: root/themes/hugo-whisper-theme/exampleSite/content/docs/configure
diff options
context:
space:
mode:
Diffstat (limited to 'themes/hugo-whisper-theme/exampleSite/content/docs/configure')
-rw-r--r--themes/hugo-whisper-theme/exampleSite/content/docs/configure/index.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/themes/hugo-whisper-theme/exampleSite/content/docs/configure/index.md b/themes/hugo-whisper-theme/exampleSite/content/docs/configure/index.md
new file mode 100644
index 0000000..48d9e60
--- /dev/null
+++ b/themes/hugo-whisper-theme/exampleSite/content/docs/configure/index.md
@@ -0,0 +1,53 @@
+---
+title: 'Configuration'
+date: 2019-02-11T19:30:08+10:00
+draft: false
+weight: 4
+summary: Syntax highlighting and menus can be configured via `config.toml`.
+---
+
+## Syntax Highlighting
+
+Whisper uses the in-built code highlighting that ships with hugo. https://gohugo.io/content-management/syntax-highlighting/
+
+You can insert code snippets in any markdown file by using standard code fences syntax ie:
+
+````
+```
+insert code here
+```
+````
+
+You can specify the langauge by adding a declaration after the backticks
+
+````
+```javascript
+insert code here
+```
+````
+
+### Pygments Options
+
+The following code highlighting options are configured in the `config.toml`
+
+```toml
+pygmentsCodeFences = true
+pygmentsCodefencesGuessSyntax = true
+pygmentsUseClasses = true
+```
+
+## Main menu
+
+Configure the main menu by editing the `config.toml`
+
+```toml
+[[menu.main]]
+name = "Home"
+url = "/"
+weight = 1
+
+[[menu.main]]
+name = "Docs"
+url = "/docs/"
+weight = 2
+```