https://github.com/zoni/hugo-theme-notes
Hugo theme for https://notes.nick.groenen.me
https://github.com/zoni/hugo-theme-notes
Last synced: 15 days ago
JSON representation
Hugo theme for https://notes.nick.groenen.me
- Host: GitHub
- URL: https://github.com/zoni/hugo-theme-notes
- Owner: zoni
- License: mit
- Created: 2021-01-14T20:38:08.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-21T23:16:21.000Z (over 5 years ago)
- Last Synced: 2025-02-22T13:59:51.462Z (over 1 year ago)
- Language: JavaScript
- Size: 64.5 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Notes theme
This is a Hugo port of the [sidey] theme from Ronalds Vilciņš, heavily customized for use on [notes.nick.groenen.me].
## Search
To make the built-in [lunr]-based search functionality work, follow these steps.
### Configure JSON index
In your Hugo configuration, enable the JSON output format for `/index.json` using something like the following (this example uses TOML):
```toml
[outputFormats]
[outputFormats.SearchIndex]
baseName = "index"
mediaType = "application/json"
[outputs]
home = ["HTML", "SearchIndex"]
```
### Create search page
Create `search.md` at the root of your `content` folder with these contents:
```
---
title: Search this site
---
# Search
}}">
```
This will make the search page available at `/search`.
[sidey]: https://github.com/ronv/sidey
[lunr]: https://lunrjs.com/
[notes.nick.groenen.me]: https://notes.nick.groenen.me/