diff --git a/doc/getStarted.md b/doc/getStarted.md index 29ce9e9..bb33134 100644 --- a/doc/getStarted.md +++ b/doc/getStarted.md @@ -169,7 +169,7 @@ path = "github.com/Sped0n/bridget/v2" - If you have _installation with Git_ - - `replacement`: replace the _path after the arrow_(`../..`) with the location of your local theme file (⚠️⚠️⚠️**relative path only**, example: `themes/bridget`) + - `replacement`: replace the _path after the arrow_(`../..`) with the location of your local theme file (⚠️⚠️⚠️**relative path to hugo site theme directory only([official doc](https://gohugo.io/hugo-modules/configuration/#module-configuration-top-level))**, example: `bridget`) - `path`: no change - If you have _installation with Module_, **remove the `replacements` configuration**. diff --git a/exampleSite/config/_default/hugo.toml b/exampleSite/config/_default/hugo.toml index 57d9af5..681320f 100644 --- a/exampleSite/config/_default/hugo.toml +++ b/exampleSite/config/_default/hugo.toml @@ -22,6 +22,6 @@ defaultContentLanguage = 'en' # theme as module [module] -replacements = "github.com/Sped0n/bridget/v2 -> ../.." # deploy with local dir WARN: delete this line if you want to deploy with git +replacements = "github.com/Sped0n/bridget/v2 -> ../.." # deploy with local dir (relative to hugo site theme dir) WARN: delete this line if you want to deploy with git [[module.imports]] path = "github.com/Sped0n/bridget/v2" # deploy with git (recommended) WARN: you should also set `bundled` to true in params.toml !!!