syntaxerrormmm/hugo-theme-anubis2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md installation section

Browse Source 
* Update the portion about initialising as Hugo module
* Fix the link in `setup guide`
This commit is contained in:
Vinay Pandey 2022-06-22 23:18:15 -07:00
parent 769fbb55e3
commit c92963b8ac
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -35,11 +35,25 @@ Anubis is a simple minimalist theme for [Hugo blog engine](https://gohugo.io/).
You need to install an extended version of Hugo to run this theme.
### As Hugo Module (easier and recommended)
Initiate a `hugo` module system from your project's root directory
```shell
hugo mod init github.com/<your_user>/<your_project>
```
Add the following to your `config.toml` or `config.yaml`
```toml
theme = ["github.com/Mitrichius/hugo-theme-anubis"]
```
### As Git Submodule
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.
For more information read the official [setup guide](https://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.