Add missing link def to navigation.md, fix linter config, and more (#2393)

Author: chalin

.markdownlint-cli2.yaml

@@ -0,0 +1,17 @@
+# cSpell:ignore docsy github lookandfeel iconsimages
+
+globs:
+ - '!node_modules/**'
+ - '!public/**'
+ - '!tmp/**'
+ - '!docsy.dev/**'
+ - docsy.dev/content/en/docs/content/iconsimages.md
+ - docsy.dev/content/en/docs/content/language.md
+ - docsy.dev/content/en/docs/content/lookandfeel.md
+ - docsy.dev/content/en/docs/content/navigation.md
+ # - docsy.dev/content/en/docs/content/repository-links.md
+ # - docsy.dev/content/en/docs/content/search.md
+ # - docsy.dev/content/en/docs/content/shortcodes.md
+ # - docsy.dev/content/en/docs/content/versioning.md
+config:
+ extends: .markdownlint.yaml

.markdownlint.yaml

@@ -1,11 +1,6 @@
 # See https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases
 # cSpell:ignore docsy
 
-ignores:
- - node_modules/**
- - public/**
- - docsy.dev/public/**
-
 default: true
 
 blanks-around-fences: false
@@ -19,4 +14,4 @@ no-hard-tabs: false
 no-inline-html: false
 no-trailing-punctuation: false
 no-trailing-spaces: { br_spaces: 0, strict: true}
-table-column-style: false # Causes problems in ja and zh pages
+# table-column-style: false 

assets/scss/_table.scss

@@ -4,6 +4,6 @@
  @extend .table-responsive;
 
  // The following is needed for tables to be responsive.
- // For details, see the https://docsy.dev/docs/adding-content/lookandfeel/#tables
+ // For details, see the https://docsy.dev/docs/content/lookandfeel/#tables
  display: block;
 }

assets/scss/_variables_project.scss

@@ -1,4 +1,4 @@
 /*
 Projects can override this file. For details, see:
-https://www.docsy.dev/docs/adding-content/lookandfeel/#project-style-files
+https://www.docsy.dev/docs/content/lookandfeel/#project-style-files
 */

assets/scss/_variables_project_after_bs.scss

@@ -1,4 +1,4 @@
 /*
 Projects can override this file. For details, see:
-https://www.docsy.dev/docs/adding-content/lookandfeel/#project-style-files
+https://www.docsy.dev/docs/content/lookandfeel/#project-style-files
 */

docsy.dev/.prettierignore

@@ -3,7 +3,7 @@
 /content/**/*.*
 !/content/en/blog/**/*.*
 !/content/en/docs/_index.md
-!/content/en/docs/adding-content/**/*.*
+!/content/en/docs/content/**/*.*
 !/content/en/site/**/*.*
 
 /layouts

docsy.dev/content/en/docs/content/adding-content.md

@@ -305,11 +305,11 @@ description: >
 
 The minimum frontmatter you need to provide is a title: everything else is up to
 you! However, if you leave out the page weight, your
-[navigation](/docs/content/navigation) may get a little disorganized. You
-may also want to include `description` since Docsy uses that to generate the
-meta `description` tag used by search engines. See [Search Engine Optimization
-(SEO) meta tags]({{< ref "feedback#search-engine-optimization-meta-tags" >}})
-for details.
+[navigation](/docs/content/navigation) may get a little disorganized. You may
+also want to include `description` since Docsy uses that to generate the meta
+`description` tag used by search engines. See [Search Engine Optimization (SEO)
+meta tags]({{< ref "feedback#search-engine-optimization-meta-tags" >}}) for
+details.
 
 ## Page contents and markup
 
@@ -360,8 +360,8 @@ markup:
 {{% /alert %}}
 
 In addition to your marked-up text, you can also use Hugo and Docsy's
-[shortcodes](/docs/content/shortcodes): reusable chunks of HTML that you
-can use to quickly build your pages. Find out more about shortcodes in
+[shortcodes](/docs/content/shortcodes): reusable chunks of HTML that you can use
+to quickly build your pages. Find out more about shortcodes in
 [Docsy Shortcodes](/docs/content/shortcodes).
 
 {{% alert title="Note" color="info" %}} Hugo also supports adding content using
@@ -416,9 +416,9 @@ You can see examples of both approaches in this and our example site. For
 example, the source for this page is just a standalone file
 `/content/en/docs/content/adding-content.md`. However the source for
 [Docsy Shortcodes](/docs/content/shortcodes/) in this site lives in
-`/content/en/docs/content/shortcodes/index.md`, with the image resource
-used by the page in the same `/shortcodes/` directory. In Hugo terminology, this
-is called a _leaf bundle_ because it's a folder containing all the data for a
+`/content/en/docs/content/shortcodes/index.md`, with the image resource used by
+the page in the same `/shortcodes/` directory. In Hugo terminology, this is
+called a _leaf bundle_ because it's a folder containing all the data for a
 single site page without any child pages (and uses `index.md` without an
 underscore).
 
@@ -478,8 +478,8 @@ organizing your content with Docsy in
 By default a docs section landing page (the `_index.md` or `_index.html` in the
 section directory) uses a layout that adds a formatted list of links to the
 pages in the section, with their frontmatter descriptions. The
-[Content and Customization](/docs/content/) landing page in this site is
-a good example.
+[Content and Customization](/docs/content/) landing page in this site is a good
+example.
 
 To display a simple bulleted list of links to the section's pages instead,
 specify `simple_list: true` in the landing page's frontmatter:
@@ -665,16 +665,16 @@ own custom content.
 
 The example site also has an About page in `content/en/about/_index.html` using
 the same Docsy template. Again, this is made up of
-[page blocks](/docs/content/shortcodes/#shortcode-blocks), including
-another background image in `content/en/about/featured-background.jpg`. As with
-the site landing page, you can replace the image, remove or add blocks, or just
-add your own content.
+[page blocks](/docs/content/shortcodes/#shortcode-blocks), including another
+background image in `content/en/about/featured-background.jpg`. As with the site
+landing page, you can replace the image, remove or add blocks, or just add your
+own content.
 
 ### Building your own landing pages
 
 If you've just used the theme, you can still use all Docsy's provided
-[page blocks](/docs/content/shortcodes/#shortcode-blocks) (or any other
-content you want) to build your own landing pages in the same file locations.
+[page blocks](/docs/content/shortcodes/#shortcode-blocks) (or any other content
+you want) to build your own landing pages in the same file locations.
 
 ## Adding a community page
 
@@ -863,14 +863,13 @@ disableKinds: [RSS]
 
 {{% alert title=Note color=info %}}
 
-If you have enabled our [print feature](/docs/content/print/) or
-otherwise specified section-level output formats in
-`hugo.toml`/`hugo.yaml`/`hugo.json`, make sure that `"RSS"` is listed as an
-output format, otherwise you won't get section-level RSS feeds (and your blog
-section won't get a nice orange RSS button). Your
-`hugo.toml`/`hugo.yaml`/`hugo.json` specification overrides the Hugo default
-[output formats](https://gohugo.io/methods/page/outputformats/) for sections,
-which are HTML and RSS.
+If you have enabled our [print feature](/docs/content/print/) or otherwise
+specified section-level output formats in `hugo.toml`/`hugo.yaml`/`hugo.json`,
+make sure that `"RSS"` is listed as an output format, otherwise you won't get
+section-level RSS feeds (and your blog section won't get a nice orange RSS
+button). Your `hugo.toml`/`hugo.yaml`/`hugo.json` specification overrides the
+Hugo default [output formats](https://gohugo.io/methods/page/outputformats/) for
+sections, which are HTML and RSS.
 
 <!-- prettier-ignore-start -->
 {{< tabpane >}}

docsy.dev/content/en/docs/content/feedback.md

@@ -309,7 +309,8 @@ using the `description` meta tag to tell search engines what your page is about.
 For each generated page, Docsy will set the content of the meta `description` by
 using the first of the following that is defined:
 
-- The page `description` [frontmatter field](/docs/content/adding-content/#page-frontmatter)
+- The page `description`
+ [frontmatter field](/docs/content/adding-content/#page-frontmatter)
 - For non-index pages, the page [summary][], as computed by Hugo
 - The site description taken from the [site `params`][]
 

docsy.dev/content/en/docs/content/iconsimages.md

@@ -3,6 +3,7 @@ title: Logos and Images
 date: 2017-01-05
 weight: 6
 description: Add and customize logos, icons, and images in your project.
+cSpell:ignore: Icongen lookandfeel cthedot icongen imgproc
 ---
 
 ## Add your logo
@@ -57,21 +58,22 @@ release notes for Docsy's currently included version of FontAwesome.
 
 You can add FontAwesome icons to your
 [navbar](/docs/content/navigation/#adding-icons-to-the-navbar),
-[side nav](/docs/content/navigation/#adding-icons-to-the-side-nav), or
-anywhere in your text.
+[side nav](/docs/content/navigation/#adding-icons-to-the-side-nav), or anywhere
+in your text.
 
 ## Add your favicons
 
 The easiest way to do this is to create a set of favicons via
-https://cthedot.de/icongen (which lets you create a huge range of icon sizes and
-options from a single image) and/or [https://favicon.io](https://favicon.io),
-and put them in your site project's `static/favicons` directory. This will
-override the default favicons from the theme.
+[cthedot.de/icongen](https://cthedot.de/icongen) (which lets you create a huge
+range of icon sizes and options from a single image) and/or
+[https://favicon.io](https://favicon.io), and put them in your site project's
+`static/favicons` directory. This will override the default favicons from the
+theme.
 
-Note that https://favicon.io doesn't create as wide a range of sizes as Icongen
-but _does_ let you quickly create favicons from text: if you want to create text
-favicons you can use this site to generate them, then use Icongen to create more
-sizes (if necessary) from your generated `.png` file.
+Note that [favicon.io](https://favicon.io) doesn't create as wide a range of
+sizes as Icongen but _does_ let you quickly create favicons from text: if you
+want to create text favicons you can use this site to generate them, then use
+Icongen to create more sizes (if necessary) from your generated `.png` file.
 
 If you have special favicon requirements, you can create your own
 `layouts/_partials/favicons.html` with your links.
@@ -80,11 +82,11 @@ If you have special favicon requirements, you can create your own
 
 ### Landing pages
 
-Docsy's [`blocks/cover` shortcode](/docs/content/shortcodes/#blockscover)
-make it easy to add large cover images to your landing pages. The shortcode
-looks for an image with the word "background" in the name inside the landing
-page's [Page Bundle](https://gohugo.io/content-management/page-bundles/) - so,
-for example, if you've copied the example site, the landing page image in
+Docsy's [`blocks/cover` shortcode](/docs/content/shortcodes/#blockscover) make
+it easy to add large cover images to your landing pages. The shortcode looks for
+an image with the word "background" in the name inside the landing page's
+[Page Bundle](https://gohugo.io/content-management/page-bundles/) - so, for
+example, if you've copied the example site, the landing page image in
 `content/en/_index.html` is `content/en/featured-background.jpg`.
 
 You specify the preferred display height of a cover block container (and hence
@@ -109,8 +111,8 @@ For a shorter image, as in the example site's About page, use one of `min`,
 ### Other pages
 
 To add inline images to other pages, use the
-[`imgproc` shortcode](/docs/content/shortcodes/#imgproc). Alternatively,
-if you prefer, just use regular Markdown or HTML images and add your image files
-to your project's `static` directory. You can find out more about using this
+[`imgproc` shortcode](/docs/content/shortcodes/#imgproc). Alternatively, if you
+prefer, just use regular Markdown or HTML images and add your image files to
+your project's `static` directory. You can find out more about using this
 directory in
 [Adding static content](/docs/content/adding-content/#adding-static-content).

docsy.dev/content/en/docs/content/navigation.md

@@ -149,6 +149,7 @@ details, including ways to restore the legacy behavior, see [Language menu
 visibility][].
 
 [Language menu visibility]: /blog/2025/0.13.0/#language-menu-visibility
+[Multi-language support]: /docs/language/
 
 {{% /alert %}}
 
@@ -168,9 +169,9 @@ To style the light/dark mode menu, apply your custom CSS to
 
 ### Search box
 
-To configure site search, see [Search](/docs/content/search/). When
-configured, the search box appears as the last item in the top-level navbar, as
-well as the sidebar on mobile.
+To configure site search, see [Search](/docs/content/search/). When configured,
+the search box appears as the last item in the top-level navbar, as well as the
+sidebar on mobile.
 
 To style the search menu, apply your custom CSS to `.td-navbar__search`.
 
@@ -484,10 +485,10 @@ sidebar_root_for: self
 
 Examples:
 
-| `sidebar_root_for` | Example  |
-| ------------------ | -------------------------------------------------- |
+| `sidebar_root_for` | Example |
+| ------------------ | ------------------------------------------- |
 | `self` | [Content and customization](/docs/content/) |
-| `children` | [Best practices](/docs/best-practices/)  |
+| `children` | [Best practices](/docs/best-practices/) |
 
 To navigate out of a rooted section, click the “up” icon in the sidebar next to
 the section title.