hugo-theme-anubis2/README.md

70 lines
1.5 KiB
Markdown
Raw Normal View History

2020-01-12 07:51:51 +01:00
# Anubis Theme for Hugo
Anubis is a simple minimalist theme for [Hugo blog engine](https://gohugo.io/).
![Anubis Screenshot](https://raw.githubusercontent.com/mitrichius/hugo-theme-anubis/master/static/images/screenshot.png)
## Features
- Pagination
- Tags
- Archive
## 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](//gohugo.io/overview/installing/) 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
Example:
```yaml
languageCode: "en-us"
baseUrl = ""
title: "Anubis"
author: ""
theme: "anubis"
paginate: 10
2020-01-21 19:57:57 +01:00
disqusShortname: yourdiscussshortname
2020-01-22 18:51:35 +01:00
googleAnalytics: UA-123-45
2020-01-12 07:51:51 +01:00
menu:
main:
- identifier: archive
name: Archive
title: Archive
url: /posts/
weight: 0
params:
description: ""
2020-01-23 21:29:36 +01:00
images:
- images/og-featured.png
2020-01-12 07:51:51 +01:00
```
### Check your site
In order to see your site in action, run Hugo's built-in local server.
`$ hugo server`
Now enter [`localhost:1313`](http://localhost:1313/) in the address bar of your browser.
## Contributing
If you find a bug or have an idea for a feature, feel free to write an [issue](https://github.com/mitrichius/hugo-theme-anubis/issues).
## TODO
See [issues](https://github.com/mitrichius/hugo-theme-anubis/issues).
## License
MIT
(c) Dmitry Kolosov
2020