From a60fc4661f004159081b2a381a75c858f96ed66d Mon Sep 17 00:00:00 2001 From: Junyi Date: Fri, 26 Apr 2024 13:14:36 +0800 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 84bc978..bfc5ed0 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,30 @@ Inside the folder of your Hugo site run: For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo. +### Configure your site + +Don't be panic, configure Anubis2 is relatively simple. + +**This is the minimum configuration:** + +```toml +baseURL = "https://hugo-theme-anubis2.netlify.app/" +languageCode = "en-us" +theme = "anubis2" +title = "Anubis2 Demo Site" + +[author] +name = "Junyi" + +[markup.goldmark.renderer] +unsafe = true # true | false; Enable unsafe mode to have a better experience + +[markup.highlight] +style = 'base16-snazzy' # Highlight.js style +``` + +It's not too late to keep the other fields as defaults and fine-tune them when you have time! (see [Configuration Example](https://github.com/Junyi-99/hugo-theme-anubis2/wiki/Configuration-Example)) + ### Run your site In order to see your site in action, run Hugo's built-in local server.