Skip to content

Commit

Permalink
docs: Clean up README and config.toml (jakewies#65)
Browse files Browse the repository at this point in the history
* docs: Clean up README and config.toml

* refactor: update line number
  • Loading branch information
jakewies authored Jul 4, 2020
1 parent 195f0e0 commit 0459931
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 12 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,18 @@ choco install hugo-extended -confirm
At the root of your Hugo project, run:

```bash
git submodule add https://github.com/jakewies/hugo-theme-codex.git themes/codex
git submodule add https://github.com/jakewies/hugo-theme-codex.git themes/hugo-theme-codex
```

Next, copy the contents of the [default `config.toml`](https://github.com/jakewies/hugo-theme-codex/blob/master/exampleSite/config.toml) to your site's `config.toml`. Make sure to read all the comments, as there a few nuances with Hugo themes that require some changes to that file.
Next, copy the contents of the [`exampleSite/config.toml`](https://github.com/jakewies/hugo-theme-codex/blob/master/exampleSite/config.toml) to your site's `config.toml`. Make sure to read all the comments, as there a few nuances with Hugo themes that require some changes to that file.

The most important change you will need to make to the `config.toml` is removing [this line](https://github.com/jakewies/hugo-theme-codex/blob/master/exampleSite/config.toml#L2):

```
themesDir = "../../"
```

It only exists in the example site so that the demo can function properly.

Finally, run:

Expand Down
16 changes: 6 additions & 10 deletions exampleSite/config.toml
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
# REMOVE THIS
themesDir = "../../"

# DO NOT REMOVE THIS
theme = "hugo-theme-codex"

# Override these settings with your own
languageCode = "en-us"
baseURL = "https://example.org/"
copyright = "© {year}"

# The value "hugo-theme-codex" is only to get the exampleSite
# to work in this repo. Change to whatever name you gave the theme
# when you added it. If you followed the README, you should have
# added the theme using the name "codex".
theme = "hugo-theme-codex"

# REMOVE THIS!
# This is only to get the exampleSite to work in this repo.
themesDir = "../../"

# Add your Disqus shortname here.
# disqusShortname = ""

Expand Down

0 comments on commit 0459931

Please sign in to comment.