summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCollin Brooks <collin.brooks@gmail.com>2021-04-11 10:50:54 -0500
committerGitHub <noreply@github.com>2021-04-11 17:50:54 +0200
commitba38e17b1b8140ae9254c1edc6c67ffdc50eca09 (patch)
tree1da7c8e2e123ea6cd87b9be8c9f5a7ee2d61ed74 /README.md
parente2786374ada0db53a5b171f0eaeb09f7d8216891 (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 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 25df99d..052730c 100644
--- a/README.md
+++ b/README.md
@@ -163,6 +163,13 @@ disableKinds = ['taxonomy', 'taxonomyTerm']
# Set source repository location.
# Used for 'Last Modified' and 'Edit this page' links.
BookRepo = 'https://github.com/alex-shpak/hugo-book'
+
+ # Specifies commit portion of the link to the page's last modified commit hash for 'doc' page
+ # type.
+ # Required if 'BookRepo' param is set.
+ # 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.