diff --git a/docs/README.md b/docs/README.md index 19d3df14..1019e56f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ ## Hugo Version -* The site currently seems to build with hugo v0.117.0 +* The site currently seems to build with hugo [v0.117.0](https://github.com/gohugoio/hugo/releases/tag/v0.117.0) * With v0.131 we get errors with the template * See https://github.com/jlewi/foyle/issues/227 diff --git a/docs/content/en/settings/_index.md b/docs/content/en/settings/_index.md new file mode 100644 index 00000000..181ac5bc --- /dev/null +++ b/docs/content/en/settings/_index.md @@ -0,0 +1,37 @@ +--- +menu: + main: + weight: 50 +title: Settings +# TODO(jeremy): Should I create a new layout for this page? Using the docs type we wind up with the Feedback form at the bottom of the page. +# which is a bit weird +type: docs +--- + +
+

BasePath

+ If you set `BasePath` to the path where you have cloned the Foyle repository, then you will be able to click + on the link "Open In VSCode" to open the current page in VSCode. +
+
+ + + +
+ + \ No newline at end of file diff --git a/docs/layouts/partials/page-meta-links.html b/docs/layouts/partials/page-meta-links.html new file mode 100644 index 00000000..85ce12ae --- /dev/null +++ b/docs/layouts/partials/page-meta-links.html @@ -0,0 +1,76 @@ +{{/* cSpell:ignore querify subdir */ -}} +{{/* Class names ending with `--KIND` are deprecated in favor of `__KIND`, but we're keeping them for a few releases after 0.9.0 */ -}} + +{{ if .File -}} +{{ $path := strings.TrimPrefix (add hugo.WorkingDir "/") $.File.Filename -}} +{{ $gh_repo := $.Param "github_repo" -}} +{{ $gh_url := $.Param "github_url" -}} +{{ $gh_subdir := $.Param "github_subdir" | default "" -}} +{{ $gh_project_repo := $.Param "github_project_repo" -}} +{{ $gh_branch := $.Param "github_branch" | default "main" -}} +
+{{ if $gh_url -}} + {{ warnf "Warning: use of `github_url` is deprecated. For details, see https://www.docsy.dev/docs/adding-content/repository-links/#github_url-optional" -}} + {{ T "post_edit_this" }} +{{ else if $gh_repo -}} + + {{/* Adjust $path based on path_base_for_github_subdir */ -}} + {{ $ghs_base := $.Param "path_base_for_github_subdir" -}} + {{ $ghs_rename := "" -}} + {{ if reflect.IsMap $ghs_base -}} + {{ $ghs_rename = $ghs_base.to -}} + {{ $ghs_base = $ghs_base.from -}} + {{ end -}} + {{ with $ghs_base -}} + {{ $path = replaceRE . $ghs_rename $path -}} + {{ end -}} + + {{ $gh_repo_path := printf "%s/%s/%s" $gh_branch $gh_subdir $path -}} + {{ $gh_repo_path = replaceRE "//+" "/" $gh_repo_path -}} + + {{ $vscodeURL := printf "%s/%s" $gh_subdir $path -}} + {{ $viewURL := printf "%s/tree/%s" $gh_repo $gh_repo_path -}} + {{ $editURL := printf "%s/edit/%s" $gh_repo $gh_repo_path -}} + {{ $issuesURL := printf "%s/issues/new?title=%s" $gh_repo (safeURL $.Title ) -}} + {{ $newPageStub := resources.Get "stubs/new-page-template.md" -}} + {{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL -}} + {{ $newPageURL := printf "%s/new/%s?%s" $gh_repo (path.Dir $gh_repo_path) $newPageQS -}} + + + + + Open In VSCode + {{ T "post_view_this" }} + {{ T "post_edit_this" }} + {{ T "post_create_child_page" }} + {{ T "post_create_issue" }} + {{ with $gh_project_repo -}} + {{ $project_issueURL := printf "%s/issues/new" . -}} + {{ T "post_create_project_issue" }} + {{ end -}} + +{{ end -}} +{{ with .CurrentSection.AlternativeOutputFormats.Get "print" -}} + {{ T "print_entire_section" }} +{{ end }} +
+{{ end -}} \ No newline at end of file