From 39b95e7267d2192d3e9084db0763f7e49ce191c3 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 2 Feb 2024 13:39:01 -0500 Subject: [PATCH] Fix repo-links page-meta class names --- CHANGELOG.md | 7 ++++- layouts/partials/page-meta-links.html | 12 +++++---- .../docs/adding-content/repository-links.md | 27 ++++++++++++------- 3 files changed, 31 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b43abecf45..0918a7f6f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,6 +38,9 @@ For the full list of changes, see the [0.9.0] release notes. [path_base_for_github_subdir]. Projects will need to adjust the value of [path_base_for_github_subdir] to be relative to the file's physical location. +- Class names to disable [repository links] were misnamed with a suffix of the + form `--KIND`. The new suffix is `__KIND`. For details, see [Disabling links]. + - Docsy statically generates anchor-links after headings using Hugo's [render-heading.html](https://gohugo.io/templates/render-hooks/) hook. This is _potentially_ a breaking change for projects that override the hook. @@ -65,12 +68,14 @@ For the full list of changes, see the [0.9.0] release notes. [#1814]: https://github.com/google/docsy/issues/1814 [#1815]: https://github.com/google/docsy/pull/1815 [#1818]: https://github.com/google/docsy/pull/1818 +[disabling links]: + https://www.docsy.dev/docs/adding-content/repository-links/#disabling-links [mermaid]: https://www.docsy.dev/docs/adding-content/diagrams-and-formulae/#diagrams-with-mermaid [multi-language]: https://www.docsy.dev/docs/language/ [path_base_for_github_subdir]: https://www.docsy.dev/docs/adding-content/repository-links/#path_base_for_github_subdir-optional -[Repository Links]: https://www.docsy.dev/docs/adding-content/repository-links/ +[repository links]: https://www.docsy.dev/docs/adding-content/repository-links/ [union file system]: https://gohugo.io/getting-started/directory-structure/#union-file-system diff --git a/layouts/partials/page-meta-links.html b/layouts/partials/page-meta-links.html index f34b6ebbbd..bda98e0a5b 100644 --- a/layouts/partials/page-meta-links.html +++ b/layouts/partials/page-meta-links.html @@ -1,4 +1,6 @@ {{/* 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" -}} @@ -33,13 +35,13 @@ {{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL -}} {{ $newPageURL := printf "%s/new/%s?%s" $gh_repo (path.Dir $gh_repo_path) $newPageQS -}} - {{ T "post_view_this" }} - {{ T "post_edit_this" }} - {{ T "post_create_child_page" }} - {{ T "post_create_issue" }} + {{ 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" }} + {{ T "post_create_project_issue" }} {{ end -}} {{ end -}} diff --git a/userguide/content/en/docs/adding-content/repository-links.md b/userguide/content/en/docs/adding-content/repository-links.md index 5a9a7cd17c..c24a92e892 100644 --- a/userguide/content/en/docs/adding-content/repository-links.md +++ b/userguide/content/en/docs/adding-content/repository-links.md @@ -330,23 +330,32 @@ following to your [projects's `_styles_project.scss`][project-style-files] file to hide **Create child page** links from all pages: ```scss -.td-page-meta--child { display: none !important; } +.td-page-meta__child { display: none !important; } ``` -Each link kind has an associated unique class named `.td-page-meta--KIND`, as +Each link kind has an associated unique class named `.td-page-meta__KIND`, as defined by the following table: Link kind | Class name --- | --- -View page source | `.td-page-meta--view` -Edit this page | `.td-page-meta--edit` -Create child page | `.td-page-meta--child` -Create documentation issue | `.td-page-meta--issue` -Create project issue | `.td-page-meta--project-issue` +View page source | `.td-page-meta__view` +Edit this page | `.td-page-meta__edit` +Create child page | `.td-page-meta__child` +Create documentation issue | `.td-page-meta__issue` +Create project issue | `.td-page-meta__project-issue` Of course, you can also use these classes to give repository links unique styles for your project. +{{% alert title="Version note" color=warning %}} + +Class names using the `--KIND` suffix were deprecated as of [v0.9.0]. + +[v0.9.0]: https://github.com/google/docsy/blob/main/CHANGELOG.md/#090 + +{{% /alert %}} + + [git submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules -[multiple languages]: {{< relref "language" >}} -[project-style-files]: {{< relref "lookandfeel#project-style-files" >}} +[multiple languages]: {{% relref "language" %}} +[project-style-files]: {{% relref "lookandfeel#project-style-files" %}}