From b4be848b6d81b8a423d9ea1a4040d037c1f39701 Mon Sep 17 00:00:00 2001 From: weru <onewesh@gmail.com> Date: Tue, 06 Oct 2020 20:19:18 +0000 Subject: [PATCH] edit docs --- README.md | 12 +++++++++++- 1 files changed, 11 insertions(+), 1 deletions(-) diff --git a/README.md b/README.md index 48632ae..28a794c 100644 --- a/README.md +++ b/README.md @@ -30,17 +30,27 @@ hugo server ``` +> There's one drawback to this technique. Your site would always use the most up-to-date version of the theme. This might break your site if there are drastic changes that you don't like. + +You can neutralize that drawback by forking the repo instead and following the same approach. Be sure the edit the `theme = ["github.com/onweru/compose"]` from the config.toml file appropriately. + +--- + If you choose __Option 2__ or __Option 3__ below, ensure you edit the following lines in the `config.toml` file ad advised on the comments +--- + ```bash ... # this example loads the theme as hugo module # comment out line below, and uncomment the line after it if you prefer to load the theme normally -theme = ["github.com/onweru/compose"] +theme = ["github.com/onweru/compose"] # edit this if you'ld rather use a fork of this repo # theme = "compose" ... ``` +--- + ### Option 2 (recommended) Generate a new Hugo site and add this theme as a Git submodule inside your themes folder: -- Gitblit v1.10.0