I recommend using git subtree
to add the theme repository inside your own website. For this you need to have your website initialized as a git repository.
- To setup as a subtree execute these commands
# Add hugo-anemone as a remote
git remote add -f hugo-anemone https://github.com/Valac01/hugo-anemone.git
# Add as a subtree
git subtree add --prefix themes/hugo-anemone hugo-anemone main --squash
If you want to update the theme to the latest commit then pull from the remote
# pulling latest commit
git subtree pull --prefix themes/hugo-anemone hugo-anemone main --squash
Other wise you can just download the theme as a .zip
file and extract the contents inside your themes/hugo-anemone
folder
- Update your
config
file to usehugo-anemone
as a theme
theme = 'hugo-anemone'
You can add or change default site settings in your site config file config.toml
located in your website-root
folder if not you can create it yourself. Every configuration settings can be found here
.
└── config.toml
Common settings
Features
To set your website favicon copy the file in /static
folder, then add the path under favicon
and icon
params
[params]
favicon = "/logo/favicon.ico" #use this for .ico files
icon = "/logo/logo512.png" #use this for .png files
To set the logo of your website which is displayed on the navbar, set params.logo
to the path of the file in /static
folder.
[params]
logo = "/logo/navbar_logo.png"
create your own partial called hero.html
.
└── layouts
└── partials
└── hero.html
Create this page however you'll like and it'll replace the contents from theme in the home page.
You can show latest 3 pages of any section in your website.
Lets say you have a section called codes
at www.example.com/codes
and you'd like to show latest 3 pages from that section in your home page. Then you need to add params.latest.section
at you site config
file.
[[params.latest.section]]
title = "Codes" #title of the section
url = "/codes" #relative path of the section where your list of pages lies
Your articles can have cover images which will be displayed in the articles, articles list as a thumbnail and in cards.
All your cover images should be inside the static
folder
In your front matter of the article add a cover
property.
title: "Lorem ipsum dolor sit amet."
cover: "/covers/cover-image.jpg"
The theme will resize your cover image into smaller sizes to be used in the thumbnail only if you mount your cover images directory into the assets
directory. Otherwise the thumbnail will use the full size images.
To mount the directories add module.mount
property as shown in Hugo docs
[[module.mounts]]
source = "static/covers" # Your cover image directory in static folder
target = "assets/covers"
Keep in mind resizing will increase the build times, but hugo caches the processed images in resources
folder, Hugo docs. Which you can use to your advantage as a cache between builds in CI/CD environment.
Hugo will generate code highlight automatically, which is monokai
chroma style by default, to change from default styling configure the markup.highlight.style
in you site config
file.
[markup.highlight]
style = "name of style"
You could have different styles per code blocks
```js {style="colorful"}
...code
```
Or using highlight
partial
{{<highlight js "style=colorful">}}
...code
{{</highlight>}}
# cd into example site for dummy pages
cd exampleSite
# Run hugo directing to themes directory
hugo server -D --themesDir ../..