mirror of
https://github.com/thomasjsn/hugo-theme-hello-friend.git
synced 2024-11-21 23:35:08 +01:00
Fix examplePage config.toml and edit Readme
This commit is contained in:
parent
e181f8a888
commit
b442ae90c9
34
README.md
34
README.md
@ -32,7 +32,35 @@ $ git submodule add https://github.com/panr/hugo-theme-hello-friend.git themes/h
|
|||||||
|
|
||||||
## How to configure
|
## 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
|
## 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))
|
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.
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,17 +1,13 @@
|
|||||||
baseurl = "https://example.org/"
|
baseurl = "https://example.org/"
|
||||||
languageCode = "en-us"
|
languageCode = "en-us"
|
||||||
title = "Hello Friend"
|
title = "Hello Friend"
|
||||||
theme = "hello-friend"
|
theme = "hugo-theme-hello-friend"
|
||||||
copyright = ""
|
copyright = ""
|
||||||
paginate = 5
|
paginate = 5
|
||||||
|
|
||||||
[params]
|
[params]
|
||||||
subtitle = "A simple theme for Hugo"
|
subtitle = "A simple theme for Hugo"
|
||||||
|
|
||||||
# [params.logo]
|
|
||||||
# path = "/img/your-example-logo.svg"
|
|
||||||
# alt = "your_example_logo"
|
|
||||||
|
|
||||||
[menu]
|
[menu]
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
identifier = "about"
|
identifier = "about"
|
||||||
@ -20,4 +16,4 @@ paginate = 5
|
|||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
identifier = "showcase"
|
identifier = "showcase"
|
||||||
name = "Showcase"
|
name = "Showcase"
|
||||||
url = "/showcase"
|
url = "/showcase"
|
||||||
|
Loading…
Reference in New Issue
Block a user