diff --git a/themes/hyde/CHANGELOG.md b/themes/hyde/CHANGELOG.md old mode 100644 new mode 100755 diff --git a/themes/hyde/LICENSE.md b/themes/hyde/LICENSE.md old mode 100644 new mode 100755 diff --git a/themes/hyde/README.md b/themes/hyde/README.md old mode 100644 new mode 100755 index d8cb82c..5fa97e6 --- a/themes/hyde/README.md +++ b/themes/hyde/README.md @@ -11,6 +11,7 @@ It pairs a prominent sidebar with uncomplicated content. - [Installation](#installation) - [Options](#options) - [Sidebar menu](#sidebar-menu) + - [Sidebar description](#sidebar-description) - [Sticky sidebar content](#sticky-sidebar-content) - [Themes](#themes) - [Reverse layout](#reverse-layout) @@ -23,6 +24,16 @@ It pairs a prominent sidebar with uncomplicated content. ## Installation +### Quick Start + +To give you a running start this installation puts a fully configured [starter repo](https://github.com/forestryio/hyde-hugo-starter) into your Git account and sets it up in a content manager / CMS. + +_[Forestry](https://forestry.io) Starter-Kit:_ + +[![Import this project into Forestry](https://assets.forestry.io/import-to-forestry.svg)](https://app.forestry.io/quick-start?repo=forestryio/hyde-hugo-starter&provider=github&engine=hugo&version=0.49) + +### Standard Installation + To install Hyde as your default theme, first install this repository in the `themes/` directory: $ cd themes/ @@ -42,7 +53,49 @@ Hyde includes some customizable options, typically applied via classes on the `< ### Sidebar menu -Create a list of nav links in the sidebar by assigning "menu=main" in the front matter. +Create a list of nav links in the sidebar by assigning "menu=main" in the front matter, like so: + +**TOML** +```toml +theme = "hyde" + +[Menus] + main = [ + {Name = "Github", URL = "https://github.com/username/"}, + {Name = "LinkedIn", URL = "https://www.linkedin.com/in/username/"} + ] +``` + +**YAML** +```yaml +theme: "hyde" + +Menus: + main: + - Name: "Github" + URL: "https://github.com/username/" + - Name: "LinkedIn" + URL: "https://www.linkedin.com/in/username/" +``` + +### Sidebar description +Customise the describe of your page using `description`, like so: + +**TOML** +```toml +theme = "hyde" + +[params] + description = "Your custom description" +``` + +**YAML** +```yaml +theme: "hyde" + +params: + description = "Your custom description" +``` ### Sticky sidebar content diff --git a/themes/hyde/archetypes/default.md b/themes/hyde/archetypes/default.md old mode 100644 new mode 100755 diff --git a/themes/hyde/go.mod b/themes/hyde/go.mod new file mode 100755 index 0000000..3ee4de3 --- /dev/null +++ b/themes/hyde/go.mod @@ -0,0 +1,3 @@ +module github.com/spf13/hyde + +go 1.12 diff --git a/themes/hyde/images/screenshot.png b/themes/hyde/images/screenshot.png old mode 100644 new mode 100755 diff --git a/themes/hyde/images/tn.png b/themes/hyde/images/tn.png old mode 100644 new mode 100755 diff --git a/themes/hyde/layouts/404.html b/themes/hyde/layouts/404.html old mode 100644 new mode 100755 diff --git a/themes/hyde/layouts/_default/baseof.html b/themes/hyde/layouts/_default/baseof.html old mode 100644 new mode 100755 diff --git a/themes/hyde/layouts/_default/list.html b/themes/hyde/layouts/_default/list.html old mode 100644 new mode 100755 diff --git a/themes/hyde/layouts/_default/single.html b/themes/hyde/layouts/_default/single.html old mode 100644 new mode 100755 diff --git a/themes/hyde/layouts/index.html b/themes/hyde/layouts/index.html old mode 100644 new mode 100755 index 6b273ff..ec6d2eb --- a/themes/hyde/layouts/index.html +++ b/themes/hyde/layouts/index.html @@ -1,6 +1,6 @@ {{ define "main" -}}