mirror of
https://github.com/msfjarvis/msfjarvis.dev.git
synced 2024-06-03 04:18:56 +05:30
docs: Clean up README and config.toml (#65)
* docs: Clean up README and config.toml * refactor: update line number
This commit is contained in:
parent
76d09e8e7e
commit
b1070fe6a6
12
README.md
12
README.md
|
@ -26,10 +26,18 @@ choco install hugo-extended -confirm
|
||||||
At the root of your Hugo project, run:
|
At the root of your Hugo project, run:
|
||||||
|
|
||||||
```bash
|
```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:
|
Finally, run:
|
||||||
|
|
||||||
|
|
|
@ -1,18 +1,14 @@
|
||||||
|
# REMOVE THIS
|
||||||
|
themesDir = "../../"
|
||||||
|
|
||||||
|
# DO NOT REMOVE THIS
|
||||||
|
theme = "hugo-theme-codex"
|
||||||
|
|
||||||
# Override these settings with your own
|
# Override these settings with your own
|
||||||
languageCode = "en-us"
|
languageCode = "en-us"
|
||||||
baseURL = "https://example.org/"
|
baseURL = "https://example.org/"
|
||||||
copyright = "© {year}"
|
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.
|
# Add your Disqus shortname here.
|
||||||
# disqusShortname = ""
|
# disqusShortname = ""
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user