stolet / anatole

Anatole is a minimalist two-column hugo theme based on farbox-theme-Anatole.

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
• 100⁄100 Google Lighthouse score
• Google Analytics (optional)
• Comments powered by Disqus (optional)
• Katex support (optional)
• Twitter Cards support
• MIT License
• Fontawesome icons
• Custom CSS (optional)
• Custom JavaScript (optional)
• Medium like zoom for images
• Compliant to strict CSP
• Uses Hugo pipes to process assets

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

Favicon

Add you own favicon in static/favicons/favicon.ico.

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

  [[menu.main]]
  name = "About"
  weight = 300
  identifier = "about"
  url = "/about/"

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

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 and the frontmatter of a page.

In the config.toml you can configure a site feature image. This image will be displayed, if no image is defined in the frontmatter of a page.

[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"]

Custom CSS

You can add your custom CSS files with the customCss parameter of the configuration file. Put your files into the assets/css directory.

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 parameter of the configuration file. Put your files into the assets/js directory.

[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 and world.js will be bundled into a 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"]

Content Security Policy

The theme is compliant with 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' stackpath.bootstrapcdn.com;
  img-src 'self';
  object-src 'none';
  script-src 'self';
  style-src 'self' stackpath.bootstrapcdn.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 file in your sites static folder. The content might look like the following:

/*
  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' stackpath.bootstrapcdn.com; img-src 'self'; object-src 'none'; script-src 'self'; style-src 'self' stackpath.bootstrapcdn.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 parameter:

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

Robots.txt

If you want Hugo to generate a robots.txt, you will have to set the enableRobotsTXT in the config.toml to true. By default a robots.txt, which allows search engine crawlers to access to any page, will be generated. It will look like this:

User-agent: *

If certain sites shoud be excluded from being accessed, you might want to setup a custom robots.txt file within your static folder of your site.

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.