Skip to content

Commit b87dfc8

Browse files
authored
ReadMe: Add hugo config custom params documentation (#433)
1 parent 9f1a1f8 commit b87dfc8

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,41 @@ You can reuse the content of any file in the includes directory using the follow
8787
```md
8888
{{< include "filename.md" >}}
8989
```
90+
91+
### Hugo Config
92+
93+
We have several **optional** custom options to add to your config `toml` or `yaml`.
94+
95+
### `searchOnPage`
96+
Option to add a coveo searchbar on top of the coveo filters on a search results page.
97+
98+
Example:
99+
```toml
100+
[params]
101+
searchOnPage = true
102+
```
103+
### `featureFlags`
104+
Options to add feature flags. Syntax denoted by prefix `disable_`.
105+
106+
Example:
107+
```toml
108+
[params]
109+
...
110+
[params.featureFlags]
111+
disable_coveo = true
112+
disable_qualtrics = true
113+
```
114+
115+
### `typographer`
116+
Options to translate plain ASCII punctuation characters into typographic-punctuation HTML entities. More info [here](https://gohugo.io/configuration/markup/#typographer).
117+
118+
Example:
119+
```toml
120+
[markup]
121+
...
122+
[markup.goldmark.extensions.typographer]
123+
rightDoubleQuote = '&quot;'
124+
leftDoubleQuote = '&quot;'
125+
rightSingleQuote = '&apos;'
126+
leftSingleQuote = '&apos;'
127+
```

0 commit comments

Comments
 (0)