diff options
author | Quentin Dufour <quentin@deuxfleurs.fr> | 2021-10-01 14:32:43 +0200 |
---|---|---|
committer | Quentin Dufour <quentin@deuxfleurs.fr> | 2021-10-01 14:32:43 +0200 |
commit | 9ccf652c00457e46eaf46fc4cb8f6d0ee582c5ef (patch) | |
tree | b02c0a9a15de80acb3661163d469da41cd6aa8c3 /themes/hugo-whisper-theme/exampleSite/content/docs/configure/index.md | |
download | rfid-9ccf652c00457e46eaf46fc4cb8f6d0ee582c5ef.tar.gz rfid-9ccf652c00457e46eaf46fc4cb8f6d0ee582c5ef.zip |
Initial commit
Diffstat (limited to 'themes/hugo-whisper-theme/exampleSite/content/docs/configure/index.md')
-rw-r--r-- | themes/hugo-whisper-theme/exampleSite/content/docs/configure/index.md | 53 |
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 +``` |