Upgrade to Docsy 0.13.0-dev+82-gec833d2 (#395)

Author: chalin

.github/dependabot.yml

@@ -1,14 +1,14 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-    time: '20:00'
-  open-pull-requests-limit: 10
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: '20:00'
-  open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: daily
+      time: '20:00'
+    open-pull-requests-limit: 10
+  - package-ecosystem: bundler
+    directory: '/'
+    schedule:
+      interval: daily
+      time: '20:00'
+    open-pull-requests-limit: 10

.prettierignore

@@ -0,0 +1,6 @@
+# Note that Prettier ignore rules differ slightly from gitignore rules. The main
+# gotcha is that once a _directory_ is ignored, it's content cannot be
+# unignored.
+
+/content/fa
+/layouts

README.md

@@ -1,9 +1,10 @@
 # Docsy Example
 
-[Docsy][] is a [Hugo theme module][] for technical documentation sites, providing easy
-site navigation, structure, and more. This **Docsy Example Project** uses the Docsy
-theme component as a hugo module and provides a skeleton documentation structure for you to use.
-You can clone/copy this project and edit it with your own content, or use it as an example.
+[Docsy][] is a [Hugo theme module][] for technical documentation sites,
+providing easy site navigation, structure, and more. This **Docsy Example
+Project** uses the Docsy theme component as a hugo module and provides a
+skeleton documentation structure for you to use. You can clone/copy this project
+and edit it with your own content, or use it as an example.
 
 In this project, the Docsy theme is pulled in as a Hugo module, together with
 its dependencies:
@@ -19,55 +20,67 @@ This Docsy Example Project is hosted on [Netlify][] at [example.docsy.dev][].
 You can view deploy logs from the [deploy section of the project's Netlify
 dashboard][deploys], or this [alternate dashboard][].
 
-This is not an officially supported Google product. This project is currently maintained.
+This is not an officially supported Google product. This project is currently
+maintained.
 
 ## Using the Docsy Example Project as a template
 
-A simple way to get started is to use this project as a template, which gives you a site project that is set up and ready to use. To do this:
+A simple way to get started is to use this project as a template, which gives
+you a site project that is set up and ready to use. To do this:
 
-1. Use the dropdown for switching branches/tags to change to the **latest** released tag.
+1. Use the dropdown for switching branches/tags to change to the **latest**
+   released tag.
 
 2. Click **Use this template**.
 
-3. Select a name for your new project and click **Create repository from template**.
+3. Select a name for your new project and click **Create repository from
+   template**.
 
-4. Make your own local working copy of your new repo using git clone, replacing https://github.com/me/example.git with your repo’s web URL:
+4. Make your own local working copy of your new repo using git clone, replacing
+   https://github.com/me/example.git with your repo’s web URL:
 
 ```bash
 git clone --depth 1 https://github.com/me/example.git
 ```
 
-Depending on your environment you may need to adjust the top-level `module` settings in your project's Hugo config file, for example, by adding a proxy to use when downloading remote modules.
-You can find details of what these configuration settings do in the [Hugo modules documentation](https://gohugo.io/hugo-modules/configuration/#module-config-top-level). 
+Depending on your environment you may need to adjust the top-level `module`
+settings in your project's Hugo config file, for example, by adding a proxy to
+use when downloading remote modules. You can find details of what these
+configuration settings do in the
+[Hugo modules documentation](https://gohugo.io/hugo-modules/configuration/#module-config-top-level).
 
-Once your settings are adjusted, you can edit your own versions of the site’s source files.
+Once your settings are adjusted, you can edit your own versions of the site’s
+source files.
 
-If you want to do SCSS edits and want to publish these, you need to install `PostCSS`
+If you want to do SCSS edits and want to publish these, you need to install
+`PostCSS`
 
 ```bash
 npm install
 ```
 
 ## Running the website locally
 
-Building and running the site locally requires a recent `extended` version of [Hugo](https://gohugo.io).
-You can find out more about how to install Hugo for your environment in our
-[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide.
+Building and running the site locally requires a recent `extended` version of
+[Hugo](https://gohugo.io). You can find out more about how to install Hugo for
+your environment in our
+[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation)
+guide.
 
-Once you've made your working copy of the site repo, from the repo root folder, run:
+Once you've made your working copy of the site repo, from the repo root folder,
+run:
 
 ```bash
 hugo server
 ```
 
 ## Running a container locally
 
-You can run docsy-example inside a [Docker](https://docs.docker.com/)
-container, the container runs with a volume bound to the `docsy-example`
-folder. This approach doesn't require you to install any dependencies other
-than [Docker Desktop](https://www.docker.com/products/docker-desktop) on
-Windows and Mac, and [Docker Compose](https://docs.docker.com/compose/install/)
-on Linux.
+You can run docsy-example inside a [Docker](https://docs.docker.com/) container,
+the container runs with a volume bound to the `docsy-example` folder. This
+approach doesn't require you to install any dependencies other than
+[Docker Desktop](https://www.docker.com/products/docker-desktop) on Windows and
+Mac, and [Docker Compose](https://docs.docker.com/compose/install/) on Linux.
 
 1. Build the docker image
 
@@ -85,10 +98,10 @@ on Linux.
 
 1. Verify that the service is working.
 
-   Open your web browser and type `http://localhost:1313` in your navigation bar,
-   This opens a local instance of the docsy-example homepage. You can now make
-   changes to the docsy example and those changes will immediately show up in your
-   browser after you save.
+   Open your web browser and type `http://localhost:1313` in your navigation
+   bar, This opens a local instance of the docsy-example homepage. You can now
+   make changes to the docsy example and those changes will immediately show up
+   in your browser after you save.
 
 ### Cleanup
 
@@ -99,13 +112,16 @@ To remove the produced images run:
 ```bash
 docker-compose rm
 ```
+
 For more information see the [Docker Compose documentation][].
 
 ## Using a local Docsy clone
 
 Make sure your installed go version is `1.18` or higher.
 
-Clone the latest version of the docsy theme into the parent folder of your project. The newly created repo should now reside in a sibling folder of your site's root folder.
+Clone the latest version of the docsy theme into the parent folder of your
+project. The newly created repo should now reside in a sibling folder of your
+site's root folder.
 
 ```shell
 cd root-of-your-site
@@ -124,16 +140,24 @@ or, when using npm, prepend `local` to the script you want to invoke, e.g.:
 npm run local serve
 ```
 
-By using the `HUGO_MODULE_WORKSPACE` directive (either directly or via prefix `local` when using npm), the server now watches all files and directories inside the sibling directory `../docsy` , too. Any changes inside the local `docsy` theme clone are  now immediately picked up (hot reload), you can instantly see the effect of your local edits.
+By using the `HUGO_MODULE_WORKSPACE` directive (either directly or via prefix
+`local` when using npm), the server now watches all files and directories inside
+the sibling directory `../docsy` , too. Any changes inside the local `docsy`
+theme clone are now immediately picked up (hot reload), you can instantly see
+the effect of your local edits.
 
-In the command above, we used the environment variable `HUGO_MODULE_WORKSPACE` to tell hugo about the local workspace file `docsy.work`. Alternatively, you can declare the workspace file inside your settings file `hugo.toml`:
+In the command above, we used the environment variable `HUGO_MODULE_WORKSPACE`
+to tell hugo about the local workspace file `docsy.work`. Alternatively, you can
+declare the workspace file inside your settings file `hugo.toml`:
 
 ```toml
 [module]
   workspace = "docsy.work"
 ```
 
-Your project's `hugo.toml` file already contains these lines, the directive for workspace assignment is commented out, however. Remove the two trailing comment characters '//' so that this line takes effect.
+Your project's `hugo.toml` file already contains these lines, the directive for
+workspace assignment is commented out, however. Remove the two trailing comment
+characters '//' so that this line takes effect.
 
 ## Troubleshooting
 
@@ -148,8 +172,10 @@ Error: Error building site: "C:\Users\foo\path\to\docsy-example\content\en\_inde
 Built in 27 ms
 ```
 
-This error occurs if you are running an outdated version of Hugo. As of docsy theme version `v0.12.0`, hugo version `0.146.0` or higher is required.
-See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo) of the user guide for instructions on how to install Hugo.
+This error occurs if you are running an outdated version of Hugo. As of docsy
+theme version `v0.12.0`, hugo version `0.146.0` or higher is required. See this
+[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo)
+of the user guide for instructions on how to install Hugo.
 
 Or you may be confronted with the following error:
 
@@ -162,8 +188,10 @@ Built in 288 ms
 Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68" not found in file cache
 ```
 
-This error occurs if you have not installed the extended version of Hugo.
-See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo) of the user guide for instructions on how to install Hugo.
+This error occurs if you have not installed the extended version of Hugo. See
+this
+[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo)
+of the user guide for instructions on how to install Hugo.
 
 Or you may encounter the following error:
 
@@ -173,15 +201,17 @@ $ hugo server
 Error: failed to download modules: binary with name "go" not found
 ```
 
-This error occurs if the `go` programming language is not available on your system.
-See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language) of the user guide for instructions on how to install `go`.
-
+This error occurs if the `go` programming language is not available on your
+system. See this
+[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language)
+of the user guide for instructions on how to install `go`.
 
 [alternate dashboard]: https://app.netlify.com/sites/goldydocs/deploys
 [deploys]: https://app.netlify.com/sites/docsy-example/deploys
 [Docsy user guide]: https://docsy.dev/docs
 [Docsy]: https://github.com/google/docsy
 [example.docsy.dev]: https://example.docsy.dev
-[Hugo theme module]: https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme
+[Hugo theme module]:
+  https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme
 [Netlify]: https://netlify.com
 [Docker Compose documentation]: https://docs.docker.com/compose/gettingstarted/

assets/scss/_styles_project.scss

@@ -0,0 +1,9 @@
+/*
+Project-specific styles. For details, see:
+https://www.docsy.dev/docs/content/lookandfeel/#project-style-files
+*/
+
+// Dark mode enhancements
+@import 'td/color-adjustments-dark';
+@import 'td/code-dark';
+@import 'td/gcs-search-dark';

assets/scss/_variables_project.scss

@@ -1,6 +1,4 @@
 /*
-
-Add styles or override variables from the theme here.
-
+Projects can override this file. For details, see:
+https://www.docsy.dev/docs/content/lookandfeel/#project-style-files
 */
-

content/en/_index.md

@@ -2,76 +2,68 @@
 title: Goldydocs
 ---
 
+<style>
+  .td-heading-self-link {
+    display: none;
+  }
+</style>
+
 {{< blocks/cover title="Welcome to Goldydocs: A Docsy Example Project!" image_anchor="top" height="full" >}}
+
 <a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/">
   Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
 </a>
 <a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/google/docsy-example">
   Download <i class="fab fa-github ms-2 "></i>
 </a>
 <p class="lead mt-5">Porridge temperature assessment &mdash; in the cloud!</p>
-{{< blocks/link-down color="info" >}}
-{{< /blocks/cover >}}
 
+{{< blocks/link-down color="info" >}} {{< /blocks/cover >}}
 
 {{% blocks/lead color="primary" %}}
+
 Goldydocs provides a single web UI providing visibility into porridge
 temperature, chair size, and bed softness metrics! You can even find out who's
 been eating **your** porridge.
 
 (Sadly, Goldydocs isn't a real project, but you can use this site as an example
 to create your own real websites with [Docsy](https://docsy.dev))
+
 {{% /blocks/lead %}}
 
+{{% blocks/section color="white" type="row" %}}
 
-{{% blocks/section color="dark" type="row" %}}
 {{% blocks/feature icon="fa-lightbulb" title="New chair metrics!" %}}
+
 The Goldydocs UI now shows chair size metrics by default.
 
 Please follow this space for updates!
-{{% /blocks/feature %}}
 
+{{% /blocks/feature %}}
 
 {{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
-We do a [Pull Request](https://github.com/google/docsy-example/pulls) contributions workflow on **GitHub**. New users are always welcome!
-{{% /blocks/feature %}}
 
+We do a [Pull Request](https://github.com/google/docsy-example/pulls)
+contributions workflow on **GitHub**. New users are always welcome!
 
-{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}
-For announcement of latest features etc.
 {{% /blocks/feature %}}
 
+{{% blocks/feature icon="fab fa-x-twitter" title="Follow us on X!" url="https://x.com/docsydocs" %}}
 
-{{% /blocks/section %}}
+For announcement of latest features etc.
 
+{{% /blocks/feature %}}
 
-{{% blocks/section %}}
-This is the second section
-{.h1 .text-center}
 {{% /blocks/section %}}
 
+{{% blocks/section type="row text-center" %}}
 
-{{% blocks/section type="row" %}}
+# This is the second section
 
-{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
-Get the Goldydocs app!
-{{% /blocks/feature %}}
+{{% /blocks/section %}}
 
-{{% blocks/feature icon="fab fa-github" title="Contributions welcome!"
-    url="https://github.com/google/docsy-example" %}}
-We do a [Pull Request](https://github.com/google/docsy-example/pulls)
-contributions workflow on **GitHub**. New users are always welcome!
-{{% /blocks/feature %}}
+{{% blocks/section type="row text-center" %}}
 
-{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!"
-    url="https://twitter.com/GoHugoIO" %}}
-For announcement of latest features etc.
-{{% /blocks/feature %}}
+# This is the another section with center alignment
 
 {{% /blocks/section %}}
-
-
-{{% blocks/section %}}
-This is the another section
-{.h1 .text-center}
-{{% /blocks/section %}}