diff options
| author | Collin Brooks <collin.brooks@gmail.com> | 2021-04-11 10:50:54 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-11 17:50:54 +0200 |
| commit | ba38e17b1b8140ae9254c1edc6c67ffdc50eca09 (patch) | |
| tree | 1da7c8e2e123ea6cd87b9be8c9f5a7ee2d61ed74 /exampleSite | |
| parent | e2786374ada0db53a5b171f0eaeb09f7d8216891 (diff) | |
Add custom commit path for last edited link (#319)
- A new `BookCommitPath` paramter was added that allows the 'commit'
portion of the link to a page's last edited commit hash to be
specified.
- This is useful when github is not the default repository for a
project.
Co-authored-by: Collin Brooks <cbrooks@sentryds.com>
Diffstat (limited to 'exampleSite')
| -rw-r--r-- | exampleSite/config.toml | 7 | ||||
| -rw-r--r-- | exampleSite/config.yaml | 7 |
2 files changed, 14 insertions, 0 deletions
diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 025d382..7de852d 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -75,6 +75,13 @@ enableGitInfo = true # Used for 'Last Modified' and 'Edit this page' links. BookRepo = 'https://github.com/alex-shpak/hugo-book' + # (Optional, default 'commit') Specifies commit portion of the link to the page's last modified + # commit hash for 'doc' page type. + # Requires 'BookRepo' param. + # Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash> + # Github uses 'commit', Bitbucket uses 'commits' + # BookCommitPath = 'commit' + # Enable "Edit this page" links for 'doc' page type. # Disabled by default. Uncomment to enable. Requires 'BookRepo' param. # Edit path must point to root directory of repo. diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml index 3c552ce..0d47f6a 100644 --- a/exampleSite/config.yaml +++ b/exampleSite/config.yaml @@ -71,6 +71,13 @@ params: # Used for 'Last Modified' and 'Edit this page' links. BookRepo: https://github.com/alex-shpak/hugo-book + # (Optional, default 'commit') Specifies commit portion of the link to the page's last modified + # commit hash for 'doc' page type. + # Requires 'BookRepo' param. + # Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash> + # Github uses 'commit', Bitbucket uses 'commits' + # BookCommitPath: commit + # Enable "Edit this page" links for 'doc' page type. # Disabled by default. Uncomment to enable. Requires 'BookRepo' param. # Edit path must point to root directory of repo. |