Updating README and head.html with minor changes
This commit is contained in:
parent
09ad21a626
commit
c1bcf8c340
114
README.md
114
README.md
@ -1,125 +1,15 @@
|
|||||||
# Anubis Theme for Hugo [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/paypalme/mitrichius/1)
|
# Anubis Theme for Hugo [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/paypalme/mitrichius/1)
|
||||||
|
|
||||||
Anubis is a simple minimalist theme for [Hugo blog engine](https://gohugo.io/).
|
This fork is identical to the Anubis hugo theme aside from this modified README file and a slight change to the `layouts/partials/head.html` file to only display the page title rather than the page title and blog title separated by a hyphen.
|
||||||
|
|
||||||
![Anubis Screenshot](https://raw.githubusercontent.com/mitrichius/hugo-theme-anubis/master/images/screenshot.png)
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Dark mode (automatic, by switcher)
|
|
||||||
- Pagination
|
|
||||||
- Tags/Categories support
|
|
||||||
- Archive
|
|
||||||
- Mobile support
|
|
||||||
- Google Analytics
|
|
||||||
- Disqus
|
|
||||||
- RSS feeds
|
|
||||||
- Translations (en, ru, fr, pl)
|
|
||||||
- Custom CSS/JS
|
|
||||||
- Multilingual mode
|
|
||||||
- Robots.txt
|
|
||||||
- Favorite posts
|
|
||||||
- Pagination on post single page
|
|
||||||
- Optional "Read more" link
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Inside the folder of your Hugo site run:
|
Inside the folder of your Hugo site run:
|
||||||
|
|
||||||
$ git submodule add https://github.com/mitrichius/hugo-theme-anubis.git themes/anubis
|
$ git submodule add https://github.com/bhamill638/hugo-theme-anubis.git themes/anubis
|
||||||
|
|
||||||
For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
|
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
|
|
||||||
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:
|
|
||||||
```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
|
|
||||||
customJS:
|
|
||||||
- js/main.js # relative path to "static" directory
|
|
||||||
dateFormat: "2006-01-02"
|
|
||||||
paginationSinglePost: true
|
|
||||||
style: light-without-switcher
|
|
||||||
readMore: false
|
|
||||||
|
|
||||||
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`](http://localhost:1313/) in the address bar of your browser.
|
|
||||||
|
|
||||||
## Feature Settings
|
|
||||||
|
|
||||||
### Dark Mode
|
|
||||||
Customize via `style` param in `params` section of config.
|
|
||||||
Options:
|
|
||||||
- `light-without-switcher` - light theme, without switcher, JS-free (by default)
|
|
||||||
- `dark-without-switcher` - dark theme, without switcher, JS-free
|
|
||||||
- `auto-without-switcher` - theme based on user system settings, without switcher, JS-free
|
|
||||||
- `light` - light theme by default, can be switched by user to dark theme and back. Theme settings are saved for user
|
|
||||||
- `dark` - dark theme by default, can be switched by user to light theme and back. Theme settings are saved for user
|
|
||||||
- `auto` - theme based on user system settings by default, can be switched by user to dark/light theme. Theme settings are saved for user
|
|
||||||
|
|
||||||
### 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](https://github.com/Mitrichius/hugo-theme-anubis/tree/master/exampleSiteMultilingual) directory and documentation on [Hugo site](https://gohugo.io/content-management/multilingual/).
|
|
||||||
|
|
||||||
### 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](https://github.com/mitrichius/hugo-theme-anubis/issues) or make a PR.
|
|
||||||
|
|
||||||
## TODO
|
|
||||||
See [issues](https://github.com/mitrichius/hugo-theme-anubis/issues).
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
MIT
|
MIT
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
<meta name="referrer" content="no-referrer-when-downgrade">
|
<meta name="referrer" content="no-referrer-when-downgrade">
|
||||||
|
|
||||||
<title>{{ if .Title }}{{ .Title }} - {{ end }}{{ .Site.Title }}</title>
|
<title>{{ if .Title }}{{ .Title }}{{ else }}{{ .Site.Title }}{{end}}</title>
|
||||||
<meta name="description" content="{{ .Site.Params.Description }}">
|
<meta name="description" content="{{ .Site.Params.Description }}">
|
||||||
|
|
||||||
{{ with .OutputFormats.Get "rss" -}}
|
{{ with .OutputFormats.Get "rss" -}}
|
||||||
|
Loading…
Reference in New Issue
Block a user