diff options
| author | digitalcraftsman <digitalcraftsman@protonmail.com> | 2017-05-19 21:47:45 +0300 |
|---|---|---|
| committer | digitalcraftsman <digitalcraftsman@protonmail.com> | 2017-05-19 21:47:45 +0300 |
| commit | e422dd3c10871f72d20aeac106ed1a368c9cd4ca (patch) | |
| tree | 91578606c195ff2c2f26a43bf8d72b2085bad1e5 | |
| parent | 855e14be1ceabc65a7de8a16b8c1717157d9bef9 (diff) | |
Turn exampleSite into a full Hugo site
| -rw-r--r-- | README.md | 24 | ||||
| -rw-r--r-- | exampleSite/config.toml | 2 |
2 files changed, 7 insertions, 19 deletions
@@ -16,25 +16,11 @@ You should see a folder called `hugo-icarus-theme` inside the `themes` directory ## Setup -In the next step navigate to the `exampleSite` folder at `themes/hugo-icarus-theme/exampleSite/`. Its structure should look similar to this: - - exampleSite - ├── config.toml - ├── content - │ └── post - │ ├── creating-a-new-theme.md - │ ├── go-is-for-lovers.md - │ ├── hugo-is-for-lovers.md - │ ├── introducing-icarus-and-its-features.md - │ ├── linked-post.md - │ └── migrate-from-jekyll.md - ├── data - │ └── l10n.toml - └── static - └── banners - └── placeholder.png - -In order to get your site running, you need to copy `config.toml` and `data/l10n.toml` into the root folders. +Next, navigate to the `exampleSite` folder at `themes/hugo-type-theme/exampleSite/`. In order to get your site running, you need to copy `config.toml` and all the content of all relevant subfolders such as `data/l10n.toml` into the root folders. + +To turn the `exampleSite` folder in a standalone demo site the `themesDir` property has been set to `../..`. This way you can preview this theme by running `hugo server` inside `exampleSite` folder. + +**Due to the customized `themesDir` path Hugo will fail to find themes if you copied the `config.toml` into the root directory of a regular Hugo website.** Make sure you comment out the `themesDir` property if you use the theme in production. ## The config file diff --git a/exampleSite/config.toml b/exampleSite/config.toml index de3ee8e..86a7fdd 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -9,6 +9,8 @@ googleAnalytics = "" paginate = 10 footnotereturnlinkcontents = "↩" theme = "hugo-icarus-theme" +# Comment the themesDir option if you use this theme in production +themesDir = "../.." [permalinks] |