Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/google/docsy.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Deininger <adeininger@urbanonline.de>2022-01-14 13:12:05 +0300
committerGitHub <noreply@github.com>2022-01-14 13:12:05 +0300
commitc407f1306c3e5f893a4dd20b7a8033dcaf96d06d (patch)
tree5b677fedb4809b02214c4cebc53414d48fae4f37
parent4739cbe13fdb0a05b885469af727e710709b5d24 (diff)
User guide: update outdated information (#812)
* Update outdated documentation As of version 0.60.0, Goldmark is hugo's default Markdown processor * netlify.toml: bump to latest hugo and go versions Co-authored-by: LisaFC <lcarey@google.com>
-rw-r--r--userguide/content/en/docs/Best practices/site-guidance.md39
1 files changed, 20 insertions, 19 deletions
diff --git a/userguide/content/en/docs/Best practices/site-guidance.md b/userguide/content/en/docs/Best practices/site-guidance.md
index 6063991..9d3ee43 100644
--- a/userguide/content/en/docs/Best practices/site-guidance.md
+++ b/userguide/content/en/docs/Best practices/site-guidance.md
@@ -6,36 +6,37 @@ description: >
Tips for authoring content for your Docsy-themed Hugo site.
---
-Docsy is a theme for the [Hugo](https://gohugo.io/) static site
-generator. If you're not already familiar with Hugo and, in particular, its version of Markdown, this page provides some
+Docsy is a theme for the [Hugo](https://gohugo.io/) static site generator.
+If you're not already familiar with Hugo and, in particular, its version of Markdown, this page provides some
useful tips and potential gotchas for adding and editing content for your site. Feel free to add your own!
-## Nested lists
+## Linking
+
+By default, regular relative URLs in links are left unchanged by Hugo (they're still relative links in your site's generated HTML), hence some hardcoded relative links like `[relative cross-link](../../peer-folder/sub-file.md)` might behave unexpectedly compared to how they work on your local file system. You may find it helpful to use some of Hugo's built-in [link shortcodes](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) to avoid broken links in your generated site. For example a `{{</* ref "filename.md" */>}}` link in Hugo will actually
+find and automatically link to your file named `filename.md`.
+
+Note, however, that `ref` and `relref` links don't work with `_index` or `index` files (for example, this site's [content landing page](/docs/adding-content/)): you'll need to use regular Markdown links to section landing or other index pages. Specify these links relative to the site's root URL, for example: `/docs/adding-content/`.
+
+[Learn more about linking](/docs/adding-content/content/#working-with-links).
+
+## Nested lists (Blackfriday only)
-Hugo currently uses the [Blackfriday](https://github.com/russross/blackfriday) Markdown processor, which can be
-sensitive when it come to content that's deeply nested in a list. In particular, be aware that
+As of version 0.60.0, Hugo uses the [Goldmark](https://github.com/yuin/goldmark) Markdown processor.
+Prior to that version, [Blackfriday](https://github.com/russross/blackfriday) was Hugo's default Markdown processor.
+This processor can be sensitive when it come to content that's deeply nested in a list. In particular, be aware that
[this known issue](https://github.com/russross/blackfriday/issues/329) can surface if or when you have multiple authors and
-other contributors who might mix 'tabs' and 'spaces' when indenting lists, or fail to indent properly.
+other contributors who might mix `tabs` and `spaces` when indenting lists, or fail to indent properly.
An additional factor here is that because GitHub uses a different Markdown processor, GitHub markdown and the editor UI may
render some nested lists properly, while Blackfriday might render that same content poorly. For example, the count in a
-numbered list might restart, or your nested content within a list is not indented
+numbered list might restart, or your nested content within a list is not indented
(shows as a peer element instead of a nested child element). You may want to recommend in your contribution guidelines
([as we do](/docs/contribution-guidelines/#contributing-to-these-docs)) that contributors preview their content with Hugo
(or use Netlify's preview feature for PRs if that's your chosen deployment tool) to ensure their content renders correctly
with Blackfriday.
{{% alert title="Tip" %}}
-[Per comments on the known issue](https://github.com/russross/blackfriday/issues/329#issuecomment-277602856), some
-users have found that using 4 spaces instead of a 'tab' results in consistent behavior. For example, consider
-configuring your local editor to use 4 spaces when the **Tab** key is pressed.
+[Per comments on the known issue](https://github.com/russross/blackfriday/issues/329#issuecomment-277602856),
+users still using Blackfriday as markup processor will achieve consistent behavior when using tabs for indentation. If you don't like tabs and want to use spaces for indentation, make sure you use 4 spaces for one indentation level, other you might run into trouble. Therefore, when using spaces for indentation,
+consider configuring your local editor to use 4 spaces when the **Tab** key is pressed.
{{% /alert %}}
-
-## Linking
-
-By default, regular relative URLs in links are left unchanged by Hugo (they're still relative links in your site's generated HTML), hence some hardcoded relative links like `[relative cross-link](../../peer-folder/sub-file.md)` might behave unexpectedly compared to how they work on your local file system. You may find it helpful to use some of Hugo's built-in [link shortcodes](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) to avoid broken links in your generated site. For example a `{{</* ref "filename.md" */>}}` link in Hugo will actually
-find and automatically link to your file named `filename.md`.
-
-Note, however, that `ref` and `relref` links don't work with `_index` or `index` files (for example, this site's [content landing page](/docs/adding-content/)): you'll need to use regular Markdown links to section landing or other index pages. Specify these links relative to the site's root URL, for example: `/docs/adding-content/`.
-
-[Learn more about linking](/docs/adding-content/content/#working-with-links).