diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 58 |
1 files changed, 27 insertions, 31 deletions
@@ -7,50 +7,46 @@ To install Contrast as your default theme, first install this repository in the $ cd themes/ $ git clone https://github.com/niklasbuschmann/contrast-hugo.git -Second, specify `contrast-hugo` as your default theme in the `config.toml` file. Just add the line +Second, specify `contrast-hugo` as your default theme in the `config.yaml` file. Just add the line - theme = "contrast-hugo" + theme: "contrast-hugo" at the top of the file. -## Options - -In the `params` section of your config, you can enable a dark header style with `darkheader = true` and [icon](https://fontawesome.com/icons) support with `fontawesome = true` - which can be used by adding `pre` entries to your site's [menu](https://gohugo.io/content-management/menus/). The site title in the header can also be hidden with `hidetitle = true`. - ## Sidebar -Instead of the horizontal menu, a sidebar can be enabled with `sidebar = true`. See [here](https://niklasbuschmann.github.io/contrast/) for an example of the sidebar in action. Adding a `hidden` class to the icon tag will hide the icon on mobile devices. +Instead of the horizontal menu, a sidebar can be enabled with `sidebar: true`. See [here](https://niklasbuschmann.github.io/contrast/) for an example of the sidebar in action. Adding a `hidden` class to the icon tag will hide the icon on mobile devices. -An example `config.yaml` could look like this: +An example `config.yaml` section could look like this: ```yaml params: - sidebar = true - fontawesome = true - description = 'Made by <a href="">John Doe</a>' + sidebar: true + fontawesome: true + description: 'Made by <a href="">Blog Author</a>' menu: main: - - identifier = "home" - name = "Home" - url = "/" - weight = 1 - pre = "<span class='fas fa-home hidden'></span>" - - identifier = "about" - name = "About" - url = "/about/" - weight = 2 - pre = "<span class='fas fa-address-card hidden'></span>" - - identifier = "github" - name = "Github" - url = "https://github.com/" - weight = 3 - pre = "<span class='fab fa-github hidden'></span>" - - identifier = "feed" - name = "Subscribe" - url = "/index.xml" - weight = 4 - pre = "<span class='fas fa-rss hidden'></span>" + - identifier: "home" + name: "Home" + url: "/" + weight: 1 + pre: "<span class='fas fa-home hidden'></span>" + - identifier: "about" + name: "About" + url: "/about/" + weight: 2 + pre: "<span class='fas fa-address-card hidden'></span>" + - identifier: "github" + name: "Github" + url: "https://github.com/" + weight: 3 + pre: "<span class='fab fa-github hidden'></span>" + - identifier: "feed" + name: "Subscribe" + url: "/index.xml" + weight: 4 + pre: "<span class='fas fa-rss hidden'></span>" ``` ## Features |