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
• Dark mode
• Navigation items
• Pagination
• Multilingual
• RTL support
• Post Thumbnails (optional)
• 100⁄100 Google Lighthouse score
• Google Analytics (optional)
• Comments powered by Disqus, Commento or Utteranc.es (optional)
• SimpleAnalytics (optional)
• Katex support (optional)
• Formspree Contact Form (optional)
• Twitter Cards support
• Open Graph support
• MIT License
• Fontawesome 5.15.1 icons
• Custom CSS (optional)
• Custom JavaScript (optional)
• Medium like zoom for images
• Compliant to strict CSP
• Syntax highlighting
• Uses Hugo pipes to process assets
• Series

Preview the exampleSite

git clone https://github.com/lxndrblz/anatole.git anatole
cd anatole/exampleSite
hugo server --themesDir ../..

Quick Start

1. Add the repository into your Hugo Project repository as a submodule:

   git submodule add https://github.com/lxndrblz/anatole.git themes/anatole

   .
2. Configure your

   config.toml

   . Feel free to copy the demo

   config.toml

   and some content from the exampleSite.
3. Build your site with

   hugo serve

   and admire the result at

   http://localhost:1313/

   .

Update your installation

If you want to get the latest update of the

Anatole

git submodule update --remote --merge

Modifying the config.toml

Ìn this section, I'll discuss the custom parameters available within the

config.toml

Profile picture and slogan

[params]
title = "I'm Jane Doe"
author = "Jane Doe"
description = "Call me Jane"
profilePicture = "images/profile.jpg"

Please note that the title under the

[params]

config.toml

Please note that the slogan can be multi-lined (note the three quotes at the beginning and end):

[params]
description = """
Call me Jane
Blogging from Texas
"""

Favicon

Add your favicons to

static/favicons

• favicon.ico

• favicon-16x16.png

• favicon-32x32.png

• apple-touch-icon.png

  (resolution should be 180x180)

Copyright

By default, the copyright will show the authors name followed by the current year, but you can change this by configuring the

copyright

{{ YEAR }}

copyright = "2020-{{ YEAR }}"

Navigation items

Non-content entries can be added right from the

config.toml

[menu]

  [[menu.main]]
  name = "Home"
  identifier = "home"
  weight = 100
  url = "/"
  [[menu.main]]
  name = "Posts"
  weight = 200
  identifier = "posts"
  url = "/post/"
  [[menu.main]]
  name = "About"
  weight = 300
  identifier = "about"
  url = "/about/"

Prefer dark theme

You can easily enable the dark mode from the

config.toml

displayMode

dark

Please also note that returning visitors will see the theme that was last displayed to them on your site. If your user has his system configured to dark mode, then this will also take precedence over the

displayMode

config.toml

[params]
displayMode = "dark"

Disable Theme Switcher

You can easily disable the theme switcher from the

config.toml

disableThemeSwitcher

true

[params]
disableThemeSwitcher = true # Theme switcher is enabled by default

Disable Animations

You can easily disable the animations from the

config.toml

doNotLoadAnimations

true

[params]
doNotLoadAnimations = true # Animations are loaded by default

Control the date Format

You can change the default date formating for the

list.html

single.html

index.html

[params]
singleDateFormat = "Mon, Jan 2, 2006"
indexDateFormat = "Mon, Jan 2, 2006"
listDateFormat = "Jan 2"

Changing the sidebar/content ratio

By default, the content fills up 60% of the screen width on devices with a full HD resolution. If you want to change the ratio, adjust the

contentratio

[params]
contentratio = 0.7

Read-more Links

You can enable read-more links for truncated posts by setting the

readMore = true

summarylength

[params]
  readMore = true

Have a static page as a home page

If you prefer having a static page as your home page rather than a listing of the latest posts, then make sure you leave the

mainSections

[params]
  mainSections = []

Put any content into the

_index.md

mainSections = ["post"]

_index.md

Rename post section

If you want to have a different post section identifier, such as

/blog

postSectionName

[params]
  postSectionName = "blog"

If the parameter is not set, it will default to

post

Show full post content on the home page

If you prefer the full content of your posts to appear on the home page rather than a summary of each post, then set the parameter

fullPostContent

true

[params]
fullPostContent = true

Multilingual support

Anatole supports multilingual page setups. All you need to do is to add the languages to your 'config.toml'. For each language, you can set the custom options like title or description. It's important to include a

LanguageName

[Languages]
  [Languages.en]
  title = "My blog"
  weight = 1
  LanguageName = "EN"

  [Languages.de]
  title = "Mein blog"
  description = "Ich bin Jane"
  weight = 2
  LanguageName = "DE"

There are two ways of translating your content, either by adding a suffix in the filename, eg.

mypost.de.md

contentDir

contentDir

[languages]
  [languages.en]
    contentDir = "content/english"
    languageName = "EN"
    weight = 1

To make sure your menu is linking to the correct localized content, make sure that you customize the menu items to include the language prefix. Your menu might look like the following:

[[Languages.de.menu.main]]
url    = "/de/"
identifier = "home"
name   = "Startseite"
weight = 100

[[Languages.de.menu.main]]
name = "Beiträge"
weight = 200
identifier = "posts"
url = "/de/post/"
[[Languages.de.menu.main]]
name = "Über"
weight = 300
identifier = "about"
url = "/de/about/"

Anatole currently ships with support for some basic languages. Contributions for other language translations are welcome.

RTL support

Anatole supports RTL languages and flip the whole theme for that. To enable the RTL-mode for a specific language, it's enough to write the following code in the language params.

LanguageDirection = "rtl"

:100: Google Lighthouse score

The theme is optimized to adhere to the requirements checked for in the Lighthouse Audit. On my personal site I was able to reach a perfect 100⁄100 score.

Comments powered by Disqus

No comment section is shown on the

single.html

config.toml

disqusShortname = "XXX"

Comments powered by Utteranc.es

No comment section is shown on the

single.html

repo

config.toml

[params.utterances]
repo = "githubuser/reponame"
issueTerm = "pathname"
theme= "preferred-color-scheme"
# label =

Two notes on the security of Utteranc.es

• If you are using a strict CSP, you'll have to add the domain to it.
• The script currently has no built-in integrity check due to limitations of Utterances.

Comments powered by Commento

You can use Commento as an alternative to Disqus. All you need to do is to configure a

CommentoURL

[params]
CommentoURL = "https://commento.example.com/js/commento.js"

Comments powered by Gitalk

No comment section is shown on the

single.html

repo

config.toml

[params.gitalk]
clientID = "GitHub Application Client ID"
clientSecret = "GitHub Application Client Secret"
repo = "Repository name to store issues"
owner = "GitHub repo owner"
admin = "GitHub repo owner and collaborators, only these guys can initialize gitHub issues"

Disabling Comments Per Page

Comments can be disabled per page by setting

disableComments: true

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"

To use the modern Google Analytics 4, include the following under

[params]

[params]
gtagId = "G-XXXXXXXXXX"

Simple Analytics

To use Simple Analytics, it has to be enabled by setting the parameter to true. If you are using a custom subdomain to evade Adblockers, then specify the URL without a trailing slash.

[params.simpleAnalytics]
enable = true
# customurl = "https://analytics.example.com"

Google Site Verification

To use Google Site Verification, add the following line to the

[params]

[params]
googleSiteVerify = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"

Replace the hash with the one Google provided you.

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".

Formspree Contact Form on the Contact page

Step 1: Configure the

contactFormAction

config.toml

[params]
#contactFormAction = "https://formspree.io/f/your-form-hash-here"

Step 2: Activate the

contact: true

contact=true

exampleSite/content/contact.html

Twitter Cards support

In order to use the full functionality of Twitter cards, you will have to define a couple of settings in the

config.toml

In the

config.toml

[params]
  images = ["images/site-feature-image.png"]

To define a custom image of a page, you might want to add the following to the frontmatter of a post.

images = ["post-cover.png"]

Open Graph Support

The internal template for Open Graph protocol uses a mix of configuration variables; settings in

config.toml

Post Thumbnails

Thumbnails can be enabled easily by setting the

thumbnail

"images/landscape.jpg"

+++
...
tags = [
"thumbnail",
]
thumbnail= "images/landscape.jpg"
+++

Make sure to put the image in the

static/images/

Custom CSS

You can add your custom CSS files with the

customCss

assets/css

customCss = ["css/custom.css", "css/styles.css"]

On the user-side it will look like this:

.
└── assets
    └── css
        ├── custom.css
        └── styles.css

Custom JavaScript

You can add your custom JS files with the

customJs

assets/js

[params]
customJs = ["js/hello.js", "js/world.js"]

On the user-side, it will look like this:

.
└── assets
    └── js
        ├── hello.js
        └── world.js

hello.js

world.js

custom.min.js

You can also include links to remote javascript files (hosted on CDNs for example). But be aware that integrity settings and minification won't be applied. Further, make sure to adjust your CSP. You can load a remote script like this:

[params]
customJs = ["http://cdn.exmple.org/fancyscript.js"]

Both approaches can even be mixed:

[params]
customJs = ["https://cdn.exmple.org/fancyscript.js", "js/world.js"]

Medium Like Zoom

Enabled by default, the medium like zoom for images can be disabled by adding the following config under

[params]

[params]
enableMediumZoom = false

Content Security Policy

The theme is compliant with the most strict CSP policies out of the box. A sample CSP for an Anatole-based site would look something like this:

Content-Security-Policy "
  base-uri 'self';
  connect-src 'self';
  default-src 'self';
  frame-ancestors 'none';
  font-src 'self' cdnjs.cloudflare.com;
  img-src 'self';
  object-src 'none';
  script-src 'self';
  style-src 'self' cdnjs.cloudflare.com;
"

If you want to configure the security headers for a site running on Netlify, you want to make sure you create a special

_headers

/*
  X-Frame-Options: DENY
  X-Clacks-Overhead: "GNU Terry Pratchett"
  X-XSS-Protection: 1; mode=block
  X-Content-Type-Options: nosniff
  Referrer-Policy: same-origin
  Content-Security-Policy:  base-uri 'self'; connect-src 'self'; default-src 'self'; frame-ancestors 'none'; font-src 'self' cdnjs.cloudflare.com; img-src 'self'; object-src 'none'; script-src 'self'; style-src 'self' cdnjs.cloudflare.com;
  Strict-Transport-Security: max-age=63072000; includeSubDomains; preload

Configurable pagination section

You can configure the pages shown on the front page by altering the

mainSections

[params]
  mainSections = ["post", "docs"]

_index.md and post section header

You can place custom content, by creating

_index.md

_index.md

mainSectionsTitle

_index.md

Robots.txt

If you want Hugo to generate a robots.txt, you will have to set the

enableRobotsTXT

config.toml

true

User-agent: *

If certain sites should be excluded from being accessed, you might want to setup a custom robots.txt file within your

static

Syntax highlighting

This theme has support for Hugo's lightning-fast Chroma code highlighting. See the Hugo docs for more information.

To enable Chroma, add the following to your site parameters:

pygmentsCodeFences = true
pygmentsUseClasses = true

Then, you can generate a different style by running:

hugo gen chromastyles --style=monokailight > assets/css/syntax.css

If you get any errors, make sure the

assets/css/

syntax.css

[params]
customCss = ["css/syntax.css"]

Socials

You can add social media based icon links under your profile picture by using the

socialIcons

Font Awesome is used for the icons.

If you are using brand icons, prefix the icon value with

fab

fas

Ordering in the

config.toml

Sample branded social entry

[[params.socialIcons]]
icon = "fab fa-linkedin"
title = "Linkedin"
url = "https://de.linkedin.com/"

Sample standard social entry

[[params.socialIcons]]
icon = "fas fa-envelope"
title = "e-mail"
url = "mailto:[email protected]"

RSS

Hugo natively supports RSS. To generate a feed for a given page, append

index.xml

Note that the RSS feed at the base of your website will include all of the pages on your website. To only include posts in your RSS feed, generate the feed within the

posts/

posts/index.xml

To only generate an RSS feed for your posts, disable the RSS output for the other page types:

[outputs]
  home = ["HTML"]
  section = ["HTML", "RSS"]
  taxonomy = ["HTML"]
  term = ["HTML"]

By default, the RSS feed contains a brief summary of each page. If you prefer to show the entire contents for each page, then use the

rssFullContent

[params]
rssFullContent = true

External Redirect URLs

You can create pages, which redirect to another (external) URL with a short delay. This can be useful for migrating previously indexed URLs, which no longer exist, or for communicating complex external URLs to your readers.

You will have to define a

redirectUrl

Additionally, you can include the

{{% loading %}}

markup.goldmark.renderer

Enable Table of Contents

You can enable a table of contents on a per post basis by adding the following parameter into the front matter of the posts you want the table of contents to appear on.

+++
...
toc = true
+++

Please note that only "## H2 Headings" and "### H3 Headings" will appear in the table of contents.

Enabling Series

You can enable series, which allows splitting up a huge post into a set of multiple blog posts that are still linked. This would also provide a unique link to the full series of blog posts. Each individual post in the series will also contain links to the other parts under the heading

Posts in this Series

First, we need to enable the

series

[taxonomies]
    category = "categories"
    series = "series"
    tag = "tags"

With this enabled, we can now proceed to specify the series in the Front Matter of each post of that series.

series: - series-name

If you want to share the full series, you can do so by sharing the link

/series/

License

Anatole is licensed under the MIT license.

Maintenance

This theme is maintained by its author Alexander Bilz and with the help from these awesome contributors. Please open an issue/pull request if you want to contribute to making this theme better and more feature-complete. For PRs, please make sure that they align with the theme's goals: minimalism, speed and elegance.

Sponsoring

If you like this theme, give it a star on GitHub, and consider supporting its development:

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 used in the exampleSite.
• Go to Ales Krivec for providing the thumbnail picture used in the exampleSite image-test post.
• Go to Tobias Ahlin for his SpinKit that is used in the exampleSite redirect post.