Skip to content

Commit fdca993

Browse files
authored
chore: rename config.toml -> hugo.toml and fix typos (#335)
1 parent 1d0b006 commit fdca993

File tree

7 files changed

+26
-22
lines changed

7 files changed

+26
-22
lines changed

.github/workflows/screenshot.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ jobs:
3232
git add images/
3333
git commit -m 'chore: update screenshots'
3434
git push origin auto-update-screenshots -f
35-
gh pr create -B main -H auto-update-screenshots --title 'chore: update screenshots' --body 'Created by Github action'
35+
gh pr create -B main -H auto-update-screenshots --title 'chore: update screenshots' --body 'Created by GitHub action'
3636
env:
3737
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Gokarna is fast, responsive, and [SEO-friendly](#performance).
3232
- [Syntax highlighting](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#syntax-highlighting)
3333
- [Custom HTML, JavaScript, and CSS](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#custom-head-and-footer-html)
3434
- [Configurable Table of Contents](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#table-of-contents)
35-
- Español (Spanish/Catalan), Deutsch (German), Français (French), Polski (Polish), Português Brasileiro (Brazilian Portugese), and Русский (Russian) [translations](https://github.com/gokarna-theme/gokarna-hugo/tree/main/i18n)
35+
- Español (Spanish/Catalan), Deutsch (German), Français (French), Polski (Polish), Português Brasileiro (Brazilian Portuguese), and Русский (Russian) [translations](https://github.com/gokarna-theme/gokarna-hugo/tree/main/i18n)
3636
- Google Lato fonts
3737
- Auto-generated RSS feed
3838

exampleSite/content/posts/theme-documentation-advanced.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This is my blog.
3434

3535
### Page
3636

37-
We introduced this type to distinguish between blog posts and normal markdown pages. The reason to create this was to give the user complete freedom in creating their website. You can use this to create a portfolio of your projects or showcase your designs. The possibilites are endless and the choice is yours.
37+
We introduced this type to distinguish between blog posts and normal markdown pages. The reason to create this was to give the user complete freedom in creating their website. You can use this to create a portfolio of your projects or showcase your designs. The possibilities are endless and the choice is yours.
3838

3939
```markdown
4040
---
@@ -73,7 +73,7 @@ Detailed configuration can be found on [Hugo's official documentation](https://g
7373

7474
## Weights
7575

76-
The `weight` attribute can be added in the markdown metadata for `post` types. We have an option in our config.toml: `params.showPostsOnHomePage` which allows you to:
76+
The `weight` attribute can be added in the markdown metadata for `post` types. We have an option in our hugo.toml: `params.showPostsOnHomePage` which allows you to:
7777

7878
1. Show popular posts on home page if the value is set to `popular`. It sorts the all the posts by it's weight attribute in ascending order.
7979
2. Show recent posts on home page if the value is set to `recent`
@@ -210,7 +210,7 @@ Integration with any analytics tool: This was a personal pet peeve. User privacy
210210

211211
We preferred privacy friendly tools like [Umami](https://umami.is/) & [Fathom Analytics](https://usefathom.com/), but the downside was that no theme supported them out of the box which led to either changing the theme source code or contributing supporting code to the original theme (both of which are good ways to extend the theme, but not our ideal choice)
212212

213-
Giving users the freedom to add anything in the HTML via config.toml seemed like an elegant way to solve the problem.
213+
Giving users the freedom to add anything in the HTML via hugo.toml seemed like an elegant way to solve the problem.
214214

215215
```toml
216216
[params]
@@ -219,16 +219,17 @@ Giving users the freedom to add anything in the HTML via config.toml seemed like
219219
'''
220220
```
221221

222-
### Katex
222+
### KaTeX
223223

224-
Katex is a math typesetting library for the web which lets you write beautiful equations. To use it, add the javascript as mentioned in [their documentation](https://katex.org/docs/browser.html) in our `params.customHeadHTML`.
224+
KaTeX is a math typesetting library for the web which lets you write beautiful equations. To use it, add the javascript as mentioned in [their documentation](https://katex.org/docs/browser.html) in our `params.customHeadHTML`.
225225

226226
```toml
227227
[params]
228228
customHeadHTML = '''
229-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-Xi8rHCmBmhbuyyhbI88391ZKP2dmfnOl4rT9ZfRI7mLTdk1wblIUnrIq35nqwEvC" crossorigin="anonymous">
230-
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js" integrity="sha384-X/XCfMm41VSsqRNQgDerQczD69XqmjOOOwYQvr/uuC+j4OPoNhVgjdGFwhvN02Ja" crossorigin="anonymous"></script>
231-
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js" integrity="sha384-+XBljXPPiv+OzfbB3cVmLHf4hdUFHlWNZN5spNQ7rmHTXpd7WvJum6fIACpNNfIR" crossorigin="anonymous"></script>
229+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-5TcZemv2l/9On385z///+d7MSYlvIEw9FuZTIdZ14vJLqWphw7e7ZPuOiCHJcFCP" crossorigin="anonymous">
230+
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js" integrity="sha384-cMkvdD8LoxVzGF/RPUKAcvmm49FQ0oxwDF3BGKtDXcEc+T1b2N+teh/OJfpU0jr6" crossorigin="anonymous"></script>
231+
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js" integrity="sha384-hCXGrW6PitJEwbkoStFjeJxv+fSOOQKOPbJxSfM6G5sWZjAyWhXiTIIAmQqnlLlh" crossorigin="anonymous"
232+
onload="renderMathInElement(document.body);"></script>
232233
<script>
233234
document.addEventListener("DOMContentLoaded", function() {
234235
renderMathInElement(document.body, {
@@ -246,13 +247,12 @@ Katex is a math typesetting library for the web which lets you write beautiful e
246247
'''
247248
```
248249

249-
> Note: Make sure you use the latest version of katex and use the correct script tags as described in [their documentation](https://katex.org/docs/browser.html)
250+
> Note: Make sure you use the latest version of KaTeX and use the correct script tags as described in [their documentation](https://katex.org/docs/browser.html)
250251
251-
Then the equation `$$y_t = \beta_0 + \beta_1 x_t + \epsilon_t$$` wrapped by double `$$` would be displayed as:
252+
Then the equation `$$y_t = \beta_0 + \beta_1 x_t + \epsilon_t$$` wrapped by double `$$` is displayed as:
252253

253254
$$y_t = \beta_0 + \beta_1 x_t + \epsilon_t$$
254-
255-
The equation `$y_t = \beta_0 + \beta_1 x_t + \epsilon_t$` wrapped by single `$` would be displayed inline as $y_t = \beta_0 + \beta_1 x_t + \epsilon_t$.
255+
ihl equation `$y_t = \beta_0 + \beta_1 x_t + \epsilon_t$` wrapped by single `$` is displayed inline as $y_t = \beta_0 + \beta_1 x_t + \epsilon_t$.
256256

257257
### Comments
258258

@@ -274,7 +274,7 @@ An example with commento:
274274

275275
Hugo lets you choose the color scheme for the codeblocks. You can choose from the options here: https://xyproto.github.io/splash/docs/all.html
276276

277-
After choosing your theme, just update the `pygmentsStyle` attribute in config.toml.
277+
After choosing your theme, just update the `pygmentsStyle` attribute in hugo.toml.
278278

279279
```toml
280280
pygmentsStyle = "monokai"
@@ -312,7 +312,7 @@ tags: ["hello", "world"]
312312
---
313313
```
314314

315-
and the `metaKeywords` specified in the config.toml:
315+
and the `metaKeywords` specified in the hugo.toml:
316316

317317
```markdown
318318
[params]
@@ -369,7 +369,7 @@ A post's date and description can be hidden if it has at least one tag listed in
369369

370370
Define the [copyright notice for your site](https://gohugo.io/methods/site/copyright/). The notice will only be displayed on [page Kinds](#content-types).
371371

372-
For example, the following configuration in `config.toml` and front matter respectively...
372+
For example, the following configuration in `hugo.toml` and front matter respectively...
373373

374374
```toml
375375
copyright = "Verbatim copying and distribution of this entire article are permitted worldwide, without royalty, in any medium, provided this notice is preserved."

exampleSite/content/posts/theme-documentation-basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ The website can be automatically published and hosted with [Netlify](https://www
144144

145145
In addition to [Hugo global configuration](https://gohugo.io/overview/configuration/) and [menu configuration](#basic-configuration), Gokarna lets you define the following [parameters](https://gohugo.io/methods/site/params/) in your site configuration.
146146

147-
See this sample `config.toml`, which uses Gokarna's default values, and [exampleSite's `config.toml`](https://github.com/gokarna-theme/gokarna-hugo/blob/main/exampleSite/config.toml):
147+
See this sample `hugo.toml`, which uses Gokarna's default values, and [exampleSite's `hugo.toml`](https://github.com/gokarna-theme/gokarna-hugo/blob/main/exampleSite/hugo.toml):
148148

149149
```toml
150150
[params]

exampleSite/config.toml renamed to exampleSite/hugo.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ title = "Gokarna"
1515

1616
customHeadHTML = """
1717
<!-- KaTeX -->
18-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].0/dist/katex.min.css" integrity="sha384-Xi8rHCmBmhbuyyhbI88391ZKP2dmfnOl4rT9ZfRI7mLTdk1wblIUnrIq35nqwEvC" crossorigin="anonymous">
19-
<script defer src="https://cdn.jsdelivr.net/npm/[email protected].0/dist/katex.min.js" integrity="sha384-X/XCfMm41VSsqRNQgDerQczD69XqmjOOOwYQvr/uuC+j4OPoNhVgjdGFwhvN02Ja" crossorigin="anonymous"></script>
20-
<script defer src="https://cdn.jsdelivr.net/npm/[email protected].0/dist/contrib/auto-render.min.js" integrity="sha384-+XBljXPPiv+OzfbB3cVmLHf4hdUFHlWNZN5spNQ7rmHTXpd7WvJum6fIACpNNfIR" crossorigin="anonymous"></script>
18+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].22/dist/katex.min.css" integrity="sha384-5TcZemv2l/9On385z///+d7MSYlvIEw9FuZTIdZ14vJLqWphw7e7ZPuOiCHJcFCP" crossorigin="anonymous">
19+
<script defer src="https://cdn.jsdelivr.net/npm/[email protected].22/dist/katex.min.js" integrity="sha384-cMkvdD8LoxVzGF/RPUKAcvmm49FQ0oxwDF3BGKtDXcEc+T1b2N+teh/OJfpU0jr6" crossorigin="anonymous"></script>
20+
<script defer src="https://cdn.jsdelivr.net/npm/[email protected].22/dist/contrib/auto-render.min.js" integrity="sha384-hCXGrW6PitJEwbkoStFjeJxv+fSOOQKOPbJxSfM6G5sWZjAyWhXiTIIAmQqnlLlh" crossorigin="anonymous"></script>
2121
<script>
2222
document.addEventListener("DOMContentLoaded", function() {
2323
renderMathInElement(document.body, {

i18n/de.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[error404]
66
other = 'Diese Seite existiert (noch) nicht, gehen Sie zu zurück auf'
77
[home]
8-
other = 'Los'
8+
other = 'Startseite'
99
[nothing]
1010
other = 'Hier gibt es noch nichts zu sehen 😉'
1111
[previous]

netlify.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[build.environment]
2+
GO_VERSION = "1.24.2"
3+
HUGO_VERSION = "0.147.1"
4+
NODE_VERSION = "22"

0 commit comments

Comments
 (0)