diff --git a/README.md b/README.md index 4d38aea..8d6ca4f 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,35 @@ $ git submodule add https://github.com/panr/hugo-theme-hello-friend.git themes/h ## How to configure -The theme doesn't require any advanced configuration. Just copy `config.toml` file from `exampleSite` directory to your Hugo root directory and change params fields. +The theme doesn't require any advanced configuration. Just copy: + +``` +baseUrl = "https://example.com/" +languageCode = "en-us" +title = "Your site title" +theme = "hello-friend" +copyright = "" +paginate = 5 + +[params] + subtitle = "Your site subtitle" + +# [params.logo] +# path = "/img/your-example-logo.svg" +# alt = "Your example logo alt text" + +[menu] + [[menu.main]] + identifier = "about" + name = "About" + url = "/about" + [[menu.main]] + identifier = "contact" + name = "Contact" + url = "/contact" +``` + +to `config.toml` file in your Hugo root directory and change params fields. ## How to run your site @@ -69,7 +97,3 @@ If you spot any bugs, please use [Issue Tracker](https://github.com/panr/hugo-th Copyright © 2018 Radosław Kozieł ([@panr](https://twitter.com/panr)) The theme is released under the MIT License. Check the [original theme license](https://github.com/panr/hugo-theme-hello-friend.git/blob/master/LICENSE.md) for additional licensing information. - - - - diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 23837ee..5881e44 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -1,17 +1,13 @@ baseurl = "https://example.org/" languageCode = "en-us" title = "Hello Friend" -theme = "hello-friend" +theme = "hugo-theme-hello-friend" copyright = "" paginate = 5 [params] subtitle = "A simple theme for Hugo" -# [params.logo] -# path = "/img/your-example-logo.svg" -# alt = "your_example_logo" - [menu] [[menu.main]] identifier = "about" @@ -20,4 +16,4 @@ paginate = 5 [[menu.main]] identifier = "showcase" name = "Showcase" - url = "/showcase" \ No newline at end of file + url = "/showcase"