jk
bb4475cd05
|
5 years ago | |
---|---|---|
.. | ||
archetypes | 5 years ago | |
exampleSite | 5 years ago | |
images | 5 years ago | |
layouts | 5 years ago | |
static | 5 years ago | |
.gitattributes | 5 years ago | |
.gitignore | 5 years ago | |
LICENSE | 5 years ago | |
README.md | 5 years ago | |
theme.toml | 5 years ago |
README.md
Anatole
Anatole is a beautiful minimalist two-column hugo theme based on farbox-theme-Anatole.
Features
Anatole's aims to be minimalistic and sleek, but still brings some great functionality.
Features include:
- Profile picture and slogan
- Navigation items
- Google Analytics
- Comments powered by Disqus
- Katex support
- MIT License
- Fontawesome icons
Preview the exampleSite
git clone https://github.com/lxndrblz/anatole.git anatole
cd anatole/exampleSite
hugo server --themesDir ../..
Quick Start
- Add the repository into your Hugo Project repository as a submodule:
git submodule add https://github.com/lxndrblz/anatole.git themes/anatole
. - Configure your
config.toml
. Feel free to copy the democonfig.toml
and some content from the exampleSite. - Build your site with
hugo serve
and admire the result athttp://localhost:1313/
.
Update your installation
If you want to get the latest update of the Anatole
theme please execute this command:
git submodule update --remote --merge
Modifying the config.toml
Ìn this section I'll discuss the custom parameters available within the config.toml
. The complete sample can be found in the exampleSite folder.
Profile picture and slogan
[params]
title = "I'm Jane Doe"
author = "Jane Doe"
description = "Call me Jane"
profilePicture = "images/profile.jpg"
Navigation items
Non-content entries can be added right from the config.toml
file.
[menu]
[[menu.main]]
name = "Home"
identifier = "home"
weight = 100
url = "/"
[[menu.main]]
name = "Posts"
weight = 200
identifier = "posts"
url = "/post/"
If you want to add content to menus, please see the about.md
file as an example.
menu: main
name: "About"
weight: 300
Comments powered by Disqus
No comment section is shown on the single.html
, unless a disqus code is specified in the config.toml
file.
disqusShortname = "XXX"
Google Analytics
To use Google Analytics, a valid tracking code has to be added. If you don't want to load the code, then commend out the parameter.
googleAnalytics = "UA-123-45"
Beautiful math functions
## Math settings
[params.math]
enable = false # options: true, false. Enable math support globally, default: false. You can always enable math on per page.
use = "katex" # options: "katex", "mathjax". default is "katex".
License
Anatole is licensed under the MIT license.
Maintenance
This theme is maintained by its author Alexander Bilz. Please open an issue/pull request if you want to contribute in making this theme better and more feature-complete.
Special Thanks 🎁
- Go to Cai Cai, for the great Anatole Farbox theme that formed the foundation for this theme.
- Go to Kareya Saleh for providing the profile picture in the exampleSite.