eric/bridget
1
0
Fork 0
mirror of https://github.com/Sped0n/bridget.git synced 2026-04-17 19:49:30 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify relative path usage in documentation (#389)

Browse Source 
- 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
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/getStarted.md
View File

@@ -169,7 +169,7 @@ path = "github.com/Sped0n/bridget/v2"
- If you have _installation with Git_ - 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 - `path`: no change
- If you have _installation with Module_, **remove the `replacements` configuration**. - If you have _installation with Module_, **remove the `replacements` configuration**.

2
exampleSite/config/_default/hugo.toml
View File

@@ -22,6 +22,6 @@ defaultContentLanguage = 'en'
# theme as module # theme as module
[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]] [[module.imports]]
path = "github.com/Sped0n/bridget/v2" # deploy with git (recommended) WARN: you should also set `bundled` to true in params.toml !!! path = "github.com/Sped0n/bridget/v2" # deploy with git (recommended) WARN: you should also set `bundled` to true in params.toml !!!