Skip to content

Commit

Permalink
feat: edit link docs repo subpath
Browse files Browse the repository at this point in the history
Can be used if the folder with your content is in a subfolder so if your project wishes to contain code and docs in the same repo it's convenient to do so. Additionally includes some refactoring in the edit-page.html logic to make it  easier to manage.
  • Loading branch information
james-d-elliott committed Jan 20, 2022
1 parent 40a8705 commit 1b6a1ca
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
3 changes: 2 additions & 1 deletion config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,12 @@ alertDismissable = true
alertText = "Introducing the Doks child theme, several DX + UX updates, and more! <a class=\"alert-link stretched-link\" href=\"https://getdoks.org/blog/doks-v0.2/\">Check out Doks v0.2</a>"

# Edit Page
# repoHost [Github | Gitea | GitLab] is used for building the edit link based on git hoster
# repoHost [Github | Gitea | GitLab | Bitbucket ] is used for building the edit link based on git hoster
repoHost = "GitHub"
#repoHost = "Gitea"
docsRepo = "https://github.com/h-enk/doks"
docsRepoBranch = "master"
docsRepoSubPath = ""
editPage = false
lastMod = false

Expand Down
25 changes: 19 additions & 6 deletions layouts/partials/main/edit-page.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,29 @@
{{ $parts := slice .Site.Params.docsRepo }}
{{ $filePath := replace .File.Path "\\" "/" }}
{{ $editPath := "null" }}

{{ if (eq .Site.Params.repoHost "GitHub") }}
{{ $editPath = "/blob/" }}
{{ $parts = $parts | append "blob" .Site.Params.docsRepoBranch }}
{{ else if (eq .Site.Params.repoHost "Gitea") }}
{{ $editPath = "/_edit/" }}
{{ $parts = $parts | append "_edit" .Site.Params.docsRepoBranch }}
{{ else if (eq .Site.Params.repoHost "GitLab") }}
{{ $editPath = "/-/blob/" }}
{{ $parts = $parts | append "-/blob" .Site.Params.docsRepoBranch }}
{{ else if (eq .Site.Params.repoHost "Bitbucket") }}
{{ $parts = $parts | append "browse" .Site.Params.docsRepoBranch }}
{{ end }}

{{ $contentPath := print .Site.Params.docsRepo $editPath .Site.Params.docsRepoBranch "/content/" }}
{{ $url := print $contentPath .Lang "/" $filePath }}
{{ if isset .Site.Params "docsreposubpath" }}
{{ if not (eq .Site.Params.docsRepoSubPath "") }}
{{ $parts = $parts | append .Site.Params.docsRepoSubPath }}
{{ end }}
{{ end }}

{{ if .Site.Params.options.multilingualMode }}
{{ $parts = $parts | append "content" .Lang $filePath }}
{{ else }}
{{ $parts = $parts | append "content" $filePath }}
{{ end }}

{{ $url := delimit $parts "/" }}

<div class="edit-page">
<a href="{{ $url }}">
Expand Down

0 comments on commit 1b6a1ca

Please sign in to comment.