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:
Spedon
2024-08-29 16:04:19 +08:00
committed by GitHub
parent 2a715327f6
commit 437bbf17e0
2 changed files with 2 additions and 2 deletions

View File

@@ -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**.