Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 4.09 KB

README.md

File metadata and controls

100 lines (63 loc) · 4.09 KB
Raw

Anubis2 Theme for Hugo License: MIT Netlify Status

Anubis2 is another simple minimalist theme for Hugo blog engine, check our Demo.

image

Light Dark (Code) Dark (Math)
demo1 demo3 demo2

Important

Update Your Blog Configuration
Please ensure your blog configuration file (hugo.toml, hugo.yaml, or hugo.json) is updated to the latest version provided with the template.

Hugo frequently changes its configuration file structure, which may lead to compatibility issues if your configuration is outdated.

Check the Anubis2 template for the latest config file.

Highlighted Features

  • Multilingual
  • Dark / Light mode (Automatic switch based on system settings)
  • Table of Contents
  • Comment Support (Giscus, Disque, ISSO, Utterances, GraphComment)
  • Analytics (Google, Umami)
  • RSS feeds
  • Mobile Support
  • Full Features

Installation & Configuration

You need to install an extended version of Hugo to run this theme.

For more information read the official setup guide of Hugo.

Install theme as Git Submodule

Inside the folder of your Hugo site, run:

git submodule add https://github.com/Junyi-99/hugo-theme-anubis2.git themes/anubis2

That's all, let's configure anubis2.

Configure your site

Don't be panic, configure Anubis2 is really simple.

This is the minimum configuration:

baseURL = "https://hugo-theme-anubis2.netlify.app/"
languageCode = "en-us"
theme = "anubis2"
title = "Anubis2 Demo Site"

[params.author]
name = "Junyi"

[markup.goldmark.renderer]
unsafe = true # true | false; Enable unsafe mode to have a better experience

[markup.highlight]
style = 'base16-snazzy' # Chroma style, find more at here: https://swapoff.org/chroma/playground/

You are encouraged keeping other fields as defaults and fine-tune them when you have time! (see Full Configuration Examples)

In the other way, you can check out the example site's configuration file

Run your site

In order to see your site, run Hugo's built-in local server.

hugo server

Now enter http://localhost:1313 in the address bar of your browser to open your site.

Update Anubis2 to the latest version

In your Hugo site folder, run this command:

git submodule update --remote

Contributing

If you find a bug or have an idea for a feature, feel free to write an issue or make a PR.

License

MIT © Junyi, 2024