msfjarvis
/
msfjarvis.dev
mirror of https://github.com/msfjarvis/msfjarvis.dev.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Clean up README and config.toml (#65) 

* docs: Clean up README and config.toml

* refactor: update line number
This commit is contained in:
Jake Wiesler 2020-07-04 14:05:26 -04:00 committed by GitHub
parent 76d09e8e7e
commit b1070fe6a6
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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:

16
exampleSite/config.toml
View File

@ -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 = ""