Anubis2 is a simple but elegant theme for Hugo blog engine

Go to file

Dmitry Kolosov 6aedfa2734 Merge pull request #50 from lpmi-13/fix_insecure_link add rel attribute to address lighthouse audit issue		2020-06-25 22:53:11 +03:00
archetypes	initial commit	2020-01-12 09:51:51 +03:00
exampleSite	Add support for single page menu	2020-06-24 22:21:59 +03:00
exampleSiteMultilingual	Enable html render for example sites and updated config example in	2020-06-13 19:32:10 +03:00
i18n	Add Polish i18n	2020-05-24 18:06:02 +02:00
images	add screenshots by right way	2020-02-16 13:02:57 +03:00
layouts	add rel attribute to address lighthouse audit issue	2020-06-25 12:08:20 +01:00
static/css	Add support for single page menu	2020-06-24 22:21:59 +03:00
LICENSE	initial commit	2020-01-12 09:51:51 +03:00
README.md	Enable html render for example sites and updated config example in	2020-06-13 19:32:10 +03:00
theme.toml	change theme config from yaml to toml	2020-02-16 20:43:53 +03:00

README.md

Anubis Theme for Hugo

Anubis is a simple minimalist theme for Hugo blog engine.

Features

Pagination
Tags/Categories support
Archive
Mobile support
Google Analytics
Disqus
RSS feeds
Translations (en, ru, fr, pl)
Multilingual mode
Robots.txt
Favorite posts
Pagination on post single page

Installation

Inside the folder of your Hugo site run:

$ git submodule add https://github.com/mitrichius/hugo-theme-anubis.git themes/anubis

For more information read the official setup guide of Hugo.

Getting started

After installing the theme successfully it requires a just a few more steps to get your site running.

Update config file

If you have toml config (which is by default), you should rename it to config.yaml or adapt this config for toml syntax.

Example of config.yaml:

languageCode: "en-us"
baseUrl: ""
title: "Anubis"
theme: "anubis"
paginate: 10
disqusShortname: yourdiscussshortname
googleAnalytics: UA-123-45
enableRobotsTXT: true

menu:
  main:
  - identifier: archive
    name: Archive
    title: Archive
    url: /posts/
    weight: 0

params:
  author: ""
  description: ""
  images:
    - images/og-featured.png # relative path to "static" directory
  customCSS:
    - css/my.css # relative path to "static" directory
  dateFormat: "2006-01-02"
  paginationSinglePost: true

markup:
  goldmark:
    renderer:
      unsafe: true # enable raw HTML in Markdown

Check your site

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

$ hugo server

Now enter localhost:1313 in the address bar of your browser.

Feature Settings

Google Analytics

Only works for production environment. You either build your site with variable like HUGO_ENV=production hugo --minify or just put env: production to params section of config.

Multilingual mode

Check config/example usage in exampleSiteMultilingual directory and documentation on Hugo site.

Robots.txt

Based on environment.
For production — allow all, for other — disallow all.

Favorite posts

To mark posts as favorite just add favorite: true in post's front matter. It adds a "★" icon nearby post's title.

Pagination on post single page

Enabled by paginationSinglePost param in params section of config.

Contributing

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

TODO

See issues.

License

MIT