From bb298a0e8329889513c055a5984a4231980d96a0 Mon Sep 17 00:00:00 2001 From: Roger Gonzalez Date: Mon, 9 Jan 2023 19:57:39 -0300 Subject: Cleaned up docs directory --- content/docs/configure.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 content/docs/configure.md (limited to 'content/docs/configure.md') diff --git a/content/docs/configure.md b/content/docs/configure.md new file mode 100644 index 0000000..48d9e60 --- /dev/null +++ b/content/docs/configure.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 +``` -- cgit v1.2.3