Not actively maintained.
This is my personal theme that I am currently using in my Digital Garden (based on @alex-shpak's Hugo Book theme).
I created this theme to learn more about Hugo theming and web-development, and I am sharing to contribute to the Digital Garden community. Unfortunately, I am not an expert in this area and I have limited availability. If you like this theme feel free to contribute! Thank you!
In summary, it changes the Hugo Book to use a tag-based/backlink navigation:
- Automatic backlink generation.
- Automatic graph generator to explore one's notes.
- Tag Explorer side-menu to easily find your notes.
Some styling choices and simplificates were were made. Some features I might have removed to simplify things.
- Hugo 0.85 or higher
- Hugo extended version, read more here
Navigate to your hugo project root and run:
$ git submodule add https://github.com/bphenriques/explorer-hugo-theme themes/explorerThen either:
- Run hugo with the theme set:
hugo server --minify --theme explorer - Set
themeconfiguration setting toexplorer.
This theme supports two types of content:
notes: holds the main content of your digital garden.posts: holds blog posts. It is not the main use-case of this theme, so a minimal set of features is provided.
There are a few configuration options that you can add to your config.toml file.
# (Optional) Set Google Analytics if you use it to track your website.
# Always put it on the top of the configuration file, otherwise it won't work
googleAnalytics = "UA-XXXXXXXXX-X"
# (Optional) Set this to true to enable 'Last Modified by' date and git author
enableGitInfo = true
[params]
# (Optional, default light) Sets color theme: light, dark or auto.
# Theme 'auto' switches between dark and light modes based on browser/os preferences
Theme = 'dark'
# (Optional, default to title) Sets the brand's name.
BrandTitle = 'My Page'
# (Optional, default true) Controls if the content's menu should be shown.
ContentMenu = true
# (Optional, default true) Controls if backlinks should be displayed.
Backlinks = true
# (Optional, default true) Controls table of contents visibility on right side of the page.
# You can also specify this parameter per page in front matter.
ToC = true
# (Optional, default none) Set the path to a logo. If the logo is /static/logo.png then the path would be 'logo.png'
Logo = 'logo.png'
# (Optional, default January 2, 2006) Configure the date format used to render dates.
DateFormat = 'January 2, 2006'
# (Optional, default true) Enables search function with flexsearch,
# Index is built on fly, therefore it might slowdown your website.
Search = trueYou can specify additional params in the front matter of individual pages:
# Use either type 'notes' or 'posts'
type = 'notes'
# (Optional) Set 'false' to hide ToC from page
ToC = true
tags = ["tag1", "tag2"]
# (Optional) Set to 'false' to exclude page from search index.
searchExclude = trueSupport in the future. Let me know what you are looking for.
| File | Description |
|---|---|
static/favicon.png |
Override default favicon |
assets/scss/override/_custom.scss |
Customise or override scss styles |
assets/scss/override/_variables.scss |
Override default SCSS variables |
assets/scss/_fonts.scss |
Replace default font with custom fonts (e.g. local files or remote like google fonts) |
assets/js/mermaid.json |
Replace Mermaid initialization config |
There are a few features implemented as plugable scss styles. Usually these are features that don't make it to the core but can still be useful.
| Plugin | Description |
|---|---|
assets/plugins/_scrollbars.scss |
Overrides scrollbar styles to look similar across platforms |
To enable plugins, add @import "plugins/{name}"; to assets/_custom.scss in your website root.
There are a few hugo templates inserted in <head>
To disable Open Graph inclusion you can create your own empty file \layouts\_internal\opengraph.html.
In fact almost empty not quite empty because an empty file looks like absent for HUGO. For example:
<!-- -->
By default, Goldmark trims unsafe outputs which might prevent some shortcodes from rendering. It is recommended to set markup.goldmark.renderer.unsafe=true if you encounter problems.
[markup.goldmark.renderer]
unsafe = trueThis theme wouldn't be possible without:
- The awesome work done by @alex-shpak in Hugo Book (MIT License).
- Maggie Delano's Digital Garden for inspiration.
- Several other Digital Gardens.
Refer to contributing.