mirror of
https://github.com/Sped0n/bridget.git
synced 2026-04-14 10:09:31 -07:00
docs: clarify relative path usage in documentation (#389)
- Clarify the relative path requirement in the installation documentation - Update the comment in the configuration file to specify the relative path context Signed-off-by: Spedon Wen <realsped0n@outlook.com>
This commit is contained in:
@@ -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**.
|
||||
|
||||
@@ -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 !!!
|
||||
|
||||
Reference in New Issue
Block a user