From 8e4f008bb57a4276e9dc605e8f07b86ec327aa83 Mon Sep 17 00:00:00 2001 From: Aidan Ranney <32148529+aidanranney@users.noreply.github.com> Date: Fri, 18 Dec 2020 09:17:10 -0800 Subject: [PATCH] Add new shortcode to add missing headings to ToC (#577) Previously, the Markdown renderer was not being passed the headings to render on "language home" list pages. This moves some of the template logic into a shortcode and specifies that it should be rendered as Markdown. The shortcode is then called directly in the index pages. --- content/en/docs/languages/cpp/_index.md | 3 ++- content/en/docs/languages/csharp/_index.md | 2 ++ content/en/docs/languages/dart/_index.md | 3 ++- content/en/docs/languages/go/_index.md | 5 ++-- content/en/docs/languages/java/_index.md | 5 ++-- content/en/docs/languages/kotlin/_index.md | 5 ++-- content/en/docs/languages/python/_index.md | 3 ++- layouts/partials/docs/prog-lang-home.html | 24 ------------------ .../shortcodes/docs/prog-lang-home-content.md | 25 +++++++++++++++++++ 9 files changed, 42 insertions(+), 33 deletions(-) create mode 100644 layouts/shortcodes/docs/prog-lang-home-content.md diff --git a/content/en/docs/languages/cpp/_index.md b/content/en/docs/languages/cpp/_index.md index 29f9e14..15c0bac 100644 --- a/content/en/docs/languages/cpp/_index.md +++ b/content/en/docs/languages/cpp/_index.md @@ -1,7 +1,6 @@ --- title: C++ prog_lang_home: true -notoc: true src_repo: https://github.com/grpc/grpc content: - learn_more: @@ -14,3 +13,5 @@ content: - other: - "[grpc repo]($src_repo_url)" --- + +{{% docs/prog-lang-home-content %}} diff --git a/content/en/docs/languages/csharp/_index.md b/content/en/docs/languages/csharp/_index.md index 3f9de2c..27bdc22 100644 --- a/content/en/docs/languages/csharp/_index.md +++ b/content/en/docs/languages/csharp/_index.md @@ -15,3 +15,5 @@ content: - "[grpc repo]($src_repo_url)" - "[Daily builds](daily-builds)" --- + +{{% docs/prog-lang-home-content %}} diff --git a/content/en/docs/languages/dart/_index.md b/content/en/docs/languages/dart/_index.md index 3c59adc..07d9904 100644 --- a/content/en/docs/languages/dart/_index.md +++ b/content/en/docs/languages/dart/_index.md @@ -1,7 +1,6 @@ --- title: Dart prog_lang_home: true -notoc: true api_path: https://pub.dev/documentation/grpc content: - learn_more: @@ -12,3 +11,5 @@ content: - $src_repo_link - "[pub package](https://pub.dev/packages/grpc)" --- + +{{% docs/prog-lang-home-content %}} diff --git a/content/en/docs/languages/go/_index.md b/content/en/docs/languages/go/_index.md index 05c1b48..fbf6398 100644 --- a/content/en/docs/languages/go/_index.md +++ b/content/en/docs/languages/go/_index.md @@ -1,7 +1,6 @@ --- title: Go prog_lang_home: true -notoc: true api_path: https://pkg.go.dev/google.golang.org/grpc content: - learn_more: @@ -19,7 +18,9 @@ content: spelling: cSpell:ignore Isberner Klerk Malte youtube --- -#### Developer stories and talks {#dev-stories} +{{% docs/prog-lang-home-content %}} + +### Developer stories and talks {#dev-stories} - **[Stubbing gRPC in Go](https://jadekler.github.io/2020/10/08/stubbing-grpc.html)**, by [Jean de Klerk](https://github.com/jadekler), Google. October 8, 2020. diff --git a/content/en/docs/languages/java/_index.md b/content/en/docs/languages/java/_index.md index 3b180f8..90d8759 100644 --- a/content/en/docs/languages/java/_index.md +++ b/content/en/docs/languages/java/_index.md @@ -1,7 +1,6 @@ --- title: Java prog_lang_home: true -notoc: true spelling: cSpell:ignore javadoc Kanti Katirtzis Nikos Sharma Tomo Tuhin youtube Varun api_path: grpc-java/javadoc content: @@ -18,7 +17,9 @@ content: - "[Download]($src_repo_url#download)" --- -#### Developer stories and talks {#dev-stories} +{{% docs/prog-lang-home-content %}} + +### Developer stories and talks {#dev-stories} - [Introducing gRPC to our Hotels.com Platform — Part 1][], by Nikos Katirtzis, Software Engineer, [Hotels.com][], diff --git a/content/en/docs/languages/kotlin/_index.md b/content/en/docs/languages/kotlin/_index.md index b695bcf..7e01b07 100644 --- a/content/en/docs/languages/kotlin/_index.md +++ b/content/en/docs/languages/kotlin/_index.md @@ -1,7 +1,6 @@ --- title: Kotlin/JVM prog_lang_home: true -notoc: true language: Kotlin api_path: https://javadocs.dev/io.grpc/grpc-kotlin-stub/latest content: @@ -16,7 +15,9 @@ content: spelling: cSpell:ignore Ferrer youtube --- -#### Developer stories and talks {#dev-stories} +{{% docs/prog-lang-home-content %}} + +### Developer stories and talks {#dev-stories} - **Next Level gRPC With Kotlin and Coroutines** diff --git a/content/en/docs/languages/python/_index.md b/content/en/docs/languages/python/_index.md index 4d64bc1..6073bc3 100644 --- a/content/en/docs/languages/python/_index.md +++ b/content/en/docs/languages/python/_index.md @@ -1,7 +1,6 @@ --- title: Python prog_lang_home: true -notoc: true src_repo: https://github.com/grpc/grpc content: - learn_more: @@ -15,3 +14,5 @@ content: - "[grpc repo]($src_repo_url)" - "[Daily builds](daily-builds)" --- + +{{% docs/prog-lang-home-content %}} diff --git a/layouts/partials/docs/prog-lang-home.html b/layouts/partials/docs/prog-lang-home.html index 7dcaebf..2119348 100644 --- a/layouts/partials/docs/prog-lang-home.html +++ b/layouts/partials/docs/prog-lang-home.html @@ -1,7 +1,4 @@ -{{ $lang := lower ($.Params.language | default $.Params.title) }} {{ $Lang := .Params.title | default .Params.language }} -{{ $src_repo_url := $.Params.src_repo | default (printf "https://github.com/grpc/grpc-%s" $lang) }} -{{ $src_repo_link := printf "[grpc-%s repo](%s)" $lang $src_repo_url }}
@@ -32,27 +29,6 @@
{{ end }}
- -
- {{ with .Params.content -}} -
- {{ range $list_entry := . }} - {{ range $heading, $items := $list_entry }} - {{ $hd := printf "#### %s" (humanize $heading) -}} -
- {{ $hd | $.Page.RenderString }} - -
- {{ end }} - {{ end }} -
- {{ end }} {{ with .Content }}
{{ . }} diff --git a/layouts/shortcodes/docs/prog-lang-home-content.md b/layouts/shortcodes/docs/prog-lang-home-content.md new file mode 100644 index 0000000..902657e --- /dev/null +++ b/layouts/shortcodes/docs/prog-lang-home-content.md @@ -0,0 +1,25 @@ +{{ $lang := lower ($.Page.Params.language | default $.Page.Params.title) }} +{{ $src_repo_url := $.Page.Params.src_repo | default (printf "https://github.com/grpc/grpc-%s" $lang) }} +{{ $src_repo_link := printf "[grpc-%s repo](%s)" $lang $src_repo_url }} + +{{ with .Page.Params.content -}} +
+{{ range $list_entry := . }} +{{ range $heading, $items := $list_entry }} +{{ $hd := printf "### %s" (humanize $heading) -}} +
+ +{{ $hd }} + + +
+{{ end }} +{{ end }} +
+{{ end }}