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

update readme

Browse Source
This commit is contained in:
Junyi Hou 2024-06-14 15:40:38 +08:00
parent d3d7541077
commit 793e1778cb
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -18,11 +18,13 @@ Anubis2 is another simple minimalist theme for [Hugo blog engine](https://gohugo
- Mobile Support - Mobile Support
- [Full Features](wiki/Full-Features) - [Full Features](wiki/Full-Features)
## Installation ## Installation & Configuration
You need to install an extended version of Hugo to run this theme. You need to install an extended version of Hugo to run this theme.
### As Git Submodule For more information read the [official setup guide of Hugo](https://gohugo.io/installation/).
### Install theme as Git Submodule
Inside the folder of your Hugo site, run: Inside the folder of your Hugo site, run:
@ -30,11 +32,11 @@ Inside the folder of your Hugo site, run:
git submodule add https://github.com/Junyi-99/hugo-theme-anubis2.git themes/anubis2 git submodule add https://github.com/Junyi-99/hugo-theme-anubis2.git themes/anubis2
``` ```
For more information read the [official setup guide of Hugo](https://gohugo.io/installation/). That's all, let's configure anubis2.
### Configure your site ### Configure your site
Don't be panic, configure Anubis2 is really simple. Don't be panic, configure Anubis2 is really **simple**.
**This is the minimum configuration:** **This is the minimum configuration:**
@ -56,17 +58,19 @@ style = 'base16-snazzy' # Highlight.js style
You are encouraged keeping other fields as defaults and fine-tune them when you have time! (see [Full Configuration Examples](https://github.com/Junyi-99/hugo-theme-anubis2/wiki/Configuration-Example)) You are encouraged keeping other fields as defaults and fine-tune them when you have time! (see [Full Configuration Examples](https://github.com/Junyi-99/hugo-theme-anubis2/wiki/Configuration-Example))
In the other way, you can check out the example site's [configuration file](exampleSiteMultilingual/hugo.toml)
## Run your site ## Run your site
In order to see your site in action, run Hugo's built-in local server. In order to see your site, run Hugo's built-in local server.
```bash ```bash
hugo server hugo server
``` ```
Now enter [`http://localhost:1313`](http://localhost:1313/) in the address bar of your browser. Now enter [`http://localhost:1313`](http://localhost:1313/) in the address bar of your browser to open your site.
## Update to the latest version ## Update Anubis2 to the latest version
In your Hugo site folder, run this command: In your Hugo site folder, run this command:
@ -79,4 +83,5 @@ git submodule update --remote
If you find a bug or have an idea for a feature, feel free to write an [issue](https://github.com/Junyi-99/hugo-theme-anubis2/issues) or make a PR. If you find a bug or have an idea for a feature, feel free to write an [issue](https://github.com/Junyi-99/hugo-theme-anubis2/issues) or make a PR.
## License ## License
MIT © Junyi, 2024 MIT © Junyi, 2024