diff --git a/i18n/ar.toml b/i18n/ar.toml index a78ec98a9d..12d93820d4 100644 --- a/i18n/ar.toml +++ b/i18n/ar.toml @@ -70,6 +70,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/bg.toml b/i18n/bg.toml index 0a1d1c3153..8b3874c929 100644 --- a/i18n/bg.toml +++ b/i18n/bg.toml @@ -72,6 +72,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/de.toml b/i18n/de.toml index ed0393cbec..665eedf3b3 100644 --- a/i18n/de.toml +++ b/i18n/de.toml @@ -76,6 +76,6 @@ other = "Entwickeln und einen Beitrag leisten" [community_contribute] other = "Wenn Du aktiv beteiligen und einen Beitrag zu {{ .Site.Title }} leisten möchtest, kannst Du hier mitmachen:" [community_how_to] -other = "Wie Du selbst zu diesen Dokumenten beitragen kannst, kannst Du nachlesen in unseren" +other = "Wie Du selbst zu {{ .Site.Title }} beitragen kannst, kannst Du nachlesen in unseren" [community_guideline] other = "Richtlinien für Beiträge" diff --git a/i18n/en.toml b/i18n/en.toml index 36a12bbdc9..476b1cd67b 100644 --- a/i18n/en.toml +++ b/i18n/en.toml @@ -76,6 +76,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/es.toml b/i18n/es.toml index 2601184957..f56da3d131 100644 --- a/i18n/es.toml +++ b/i18n/es.toml @@ -48,7 +48,7 @@ other = "Notificar una incidencia con la documentanción" [post_create_project_issue] other = "Notificar una incidencia en un proyecto" [post_posts_in] -other = "Añadir entrada" +other = "Publicaciones en" [post_reading_time] other = "minutos de lectura" [post_less_than_a_minute_read] @@ -76,7 +76,7 @@ other = "¿Usas o quieres usar {{ .Site.Title }}? Encuentra más información aq [community_develop] other = "Desarrollar y Contribuir" [community_contribute] -other = "Si desea involucrarte más contribuyendo a {{ .Site.Title }}, únete a nosotros aquí:" +other = "Si deseas involucrarte más contribuyendo a {{ .Site.Title }}, únete a nosotros aquí:" [community_how_to] other = "Puedes averiguar cómo contribuir a estos documentos en nuestras" [community_guideline] diff --git a/i18n/et.toml b/i18n/et.toml index f8c8c22e60..42888cae6c 100644 --- a/i18n/et.toml +++ b/i18n/et.toml @@ -61,6 +61,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/fa.toml b/i18n/fa.toml index 294794a23f..70956fce9f 100644 --- a/i18n/fa.toml +++ b/i18n/fa.toml @@ -73,6 +73,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/fr.toml b/i18n/fr.toml index 4471616cab..b09665fe0e 100644 --- a/i18n/fr.toml +++ b/i18n/fr.toml @@ -72,6 +72,6 @@ other = "Développer et Contribuer" [community_contribute] other = "Si vous voulez vous impliquer davantage en contribuant à {{ .Site.Title }}, joignez-nous sur:" [community_how_to] -other = "Vous pouvez trouver comment contribuer à cette documentation dans nos" +other = "Vous pouvez trouver comment contribuer à {{ .Site.Title }} dans nos" [community_guideline] other = "Règles de contribution" diff --git a/i18n/hu.toml b/i18n/hu.toml index c644be1c20..32c15b2ca9 100644 --- a/i18n/hu.toml +++ b/i18n/hu.toml @@ -76,6 +76,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/it.toml b/i18n/it.toml index a01f48735c..0c05f2c706 100644 --- a/i18n/it.toml +++ b/i18n/it.toml @@ -72,6 +72,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/ja.toml b/i18n/ja.toml index c6d321fd59..74046d9d2d 100644 --- a/i18n/ja.toml +++ b/i18n/ja.toml @@ -72,6 +72,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/ko.toml b/i18n/ko.toml index 973ab2d60b..39547da0ca 100644 --- a/i18n/ko.toml +++ b/i18n/ko.toml @@ -72,6 +72,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/nl.toml b/i18n/nl.toml index 9359b2274c..8f1ac46774 100644 --- a/i18n/nl.toml +++ b/i18n/nl.toml @@ -72,6 +72,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/no.toml b/i18n/no.toml index 86e96853a1..19f51445d4 100644 --- a/i18n/no.toml +++ b/i18n/no.toml @@ -72,6 +72,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/pl.toml b/i18n/pl.toml index 2efb53ae02..aa421ef091 100644 --- a/i18n/pl.toml +++ b/i18n/pl.toml @@ -73,6 +73,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/pt-br.toml b/i18n/pt-br.toml index 1171f8d3a1..282b5f7126 100644 --- a/i18n/pt-br.toml +++ b/i18n/pt-br.toml @@ -72,6 +72,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/i18n/sv.toml b/i18n/sv.toml index a7dac1fc8f..f56b1053e8 100644 --- a/i18n/sv.toml +++ b/i18n/sv.toml @@ -76,6 +76,6 @@ other = "Utveckla och Medverka" [community_contribute] other = "Om du vill engagera dig mer genom att medverka till {{ .Site.Title }}, gå med oss här:" [community_how_to] -other = "Du kan ta reda på hur du medverkar till dessa dokument i våra" +other = "Du kan ta reda på hur du medverkar till {{ .Site.Title }} i våra" [community_guideline] other = "Riktlinjer för att Medverka" diff --git a/i18n/tr.toml b/i18n/tr.toml index f7d1cedec8..5a7acb080d 100644 --- a/i18n/tr.toml +++ b/i18n/tr.toml @@ -72,6 +72,6 @@ other = "Develop and Contribute" [community_contribute] other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:" [community_how_to] -other = "You can find out how to contribute to these docs in our" +other = "You can find out how to contribute to {{ .Site.Title }} in our" [community_guideline] other = "Contribution Guidelines" diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index d0d87c9ae1..29ad5768d7 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -1,5 +1,5 @@ - + {{ partial "head.html" . }} diff --git a/layouts/blog/baseof.html b/layouts/blog/baseof.html index b0a6946dcc..5f162b9ee4 100644 --- a/layouts/blog/baseof.html +++ b/layouts/blog/baseof.html @@ -1,5 +1,5 @@ - + {{ partial "head.html" . }} diff --git a/layouts/blog/baseof.print.html b/layouts/blog/baseof.print.html index 67a69ba9cd..b0cc3d23c7 100644 --- a/layouts/blog/baseof.print.html +++ b/layouts/blog/baseof.print.html @@ -1,5 +1,5 @@ - + {{ partial "head.html" . }} diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html index 8bc21ce691..4f8855325c 100644 --- a/layouts/docs/baseof.html +++ b/layouts/docs/baseof.html @@ -1,5 +1,5 @@ - + {{ partial "head.html" . }} diff --git a/layouts/docs/baseof.print.html b/layouts/docs/baseof.print.html index c05a0a60c4..d268ca7c37 100644 --- a/layouts/docs/baseof.print.html +++ b/layouts/docs/baseof.print.html @@ -1,5 +1,5 @@ - + {{ partial "head.html" . }} diff --git a/layouts/partials/community_links.html b/layouts/partials/community_links.html index 296e8f04a4..8162203f9f 100644 --- a/layouts/partials/community_links.html +++ b/layouts/partials/community_links.html @@ -14,7 +14,7 @@

{{ T "community_develop" }}

{{ with index $links "developer"}} {{ template "community-links-list" . }} {{ end }} -

{{ T "community_how_to" }} {{ T "community_guideline" }} +

{{ T "community_how_to" . }} {{ T "community_guideline" }} diff --git a/layouts/partials/sidebar-tree.html b/layouts/partials/sidebar-tree.html index 258267b005..fc267bbec7 100644 --- a/layouts/partials/sidebar-tree.html +++ b/layouts/partials/sidebar-tree.html @@ -5,14 +5,14 @@ {{ if not .Site.Params.ui.sidebar_search_disable -}}

{{ partial "search-input.html" . }} -
{{ else -}}
{{ partial "search-input.html" . }} -
diff --git a/layouts/swagger/baseof.html b/layouts/swagger/baseof.html index bf7baadd10..c81f209f49 100644 --- a/layouts/swagger/baseof.html +++ b/layouts/swagger/baseof.html @@ -1,5 +1,5 @@ - + {{ partial "head.html" . }} {{ if .IsHome }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{ . }} | {{ end }}{{ .Site.Title }}{{ end }} diff --git a/userguide/config.toml b/userguide/config.toml index 18cf78e9e2..3836183c45 100644 --- a/userguide/config.toml +++ b/userguide/config.toml @@ -28,13 +28,6 @@ home = [ "HTML" ] page = [ "HTML" ] section = [ "HTML", "RSS", "print"] -## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday -[blackfriday] -plainIDAnchors = true -hrefTargetBlank = true -angledQuotes = false -latexDashes = true - # Image processing configuration. [imaging] resampleFilter = "CatmullRom" diff --git a/userguide/content/en/docs/Adding content/content.md b/userguide/content/en/docs/Adding content/content.md index 5c06cec494..3324a7e8fd 100644 --- a/userguide/content/en/docs/Adding content/content.md +++ b/userguide/content/en/docs/Adding content/content.md @@ -6,7 +6,7 @@ description: > Add different types of content to your Docsy site. --- -So you've got a new Hugo website with Docsy, now it's time to add some content! This page tells you how to use the theme to add and structure your site content. +So you've got a new Hugo website with Docsy, now it's time to add some content! This page tells you how to use the theme to add and structure your site content. ## Content root directory @@ -28,7 +28,7 @@ It also provides a [default "landing page" type of template](https://github.com/ Each top-level **section** in your site corresponds to a **directory** in your site content root. Hugo automatically applies the appropriate **template** for that section, depending on which folder the content is in. For example, this page is in the `docs` subdirectory of the site's content root directory `content/en/`, so Hugo automatically applies the `docs` template. You can override this by explicitly specifying a template or content type for a particular page. -If you've copied the example site, you already have appropriately named top-level section directories for using Docsy's templates, each with an index page ( `_index.md` or `index.html`) page for users to land on. These top-level sections also appear in the example site's [top-level menu](/docs/adding-content/navigation/#top-level-menu). +If you've copied the example site, you already have appropriately named top-level section directories for using Docsy's templates, each with an index page ( `_index.md` or `index.html`) page for users to land on. These top-level sections also appear in the example site's [top-level menu](/docs/adding-content/navigation/#top-level-menu). ### Custom sections @@ -228,13 +228,14 @@ The minimum frontmatter you need to provide is a title: everything else is up to ## Page contents and markup -By default you create pages in a Docsy site as simple [Markdown or HTML files](https://gohugo.io/content-management/formats/) with [page frontmatter](#page-frontmatter), as described above. Versions of Hugo before 0.60 use [BlackFriday](https://github.com/russross/blackfriday) as its Markdown parser. From 0.60, Hugo uses [Goldmark](https://github.com/yuin/goldmark/) as its Markdown parser by default. +By default you create pages in a Docsy site as simple [Markdown or HTML files](https://gohugo.io/content-management/formats/) with [page frontmatter](#page-frontmatter), as described above. +As of version 0.100, [Goldmark](https://github.com/yuin/goldmark/) is the only Markdown parser supported by Hugo. In addition to your marked-up text, you can also use Hugo and Docsy's [shortcodes](/docs/adding-content/shortcodes): reusable chunks of HTML that you can use to quickly build your pages. Find out more about shortcodes in [Docsy Shortcodes](/docs/adding-content/shortcodes). @@ -289,7 +288,7 @@ We don't mandate any particular style for your page contents. However, if you'd ## Page bundles -You can create site pages as standalone files in their section or subsection directory, or as folders where the content is in the folder's index page. Creating a folder for your page lets you [bundle](https://gohugo.io/content-management/page-bundles/) images and other resources together with the content. +You can create site pages as standalone files in their section or subsection directory, or as folders where the content is in the folder's index page. Creating a folder for your page lets you [bundle](https://gohugo.io/content-management/page-bundles/) images and other resources together with the content. 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/adding-content.md`. However the source for [Docsy Shortcodes](/docs/adding-content/shortcodes/) in this site lives in `/content/en/docs/adding-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). @@ -303,13 +302,13 @@ The template you'll probably use most often is the [`docs` template](https://git * GitHub links (populated from your site config) for readers to edit the page or create issues * a page menu -as well as the common header and footer used by all your site's pages. Which template is applied depends on whether you've added the content to the `blog` or `docs` content directory. You can find out more about how the nav and page menu are created in [Navigation and Search](/docs/adding-content/navigation/). +as well as the common header and footer used by all your site's pages. Which template is applied depends on whether you've added the content to the `blog` or `docs` content directory. You can find out more about how the nav and page menu are created in [Navigation and Search](/docs/adding-content/navigation/). ### Organizing your documentation While Docsy's top-level sections let you create site sections for different types of content, you may also want to organize your docs content within your `docs` section. For example, this site's `docs` section directory has multiple subdirectories for **Getting Started**, **Content and Customization**, and so on. Each subdirectory has an `_index.md` (it could also be an `_index.html`), which acts as a section index page and tells Hugo that the relevant directory is a subsection of your docs. -Docsy's `docs` layout gives you a left nav pane with an autogenerated nested menu based on your `docs` file structure. Each standalone page or subsection `_index.md` or `_index.html` page in the `docs/` directory gets a top level menu item, using the link name and `weight` metadata from the page or index. +Docsy's `docs` layout gives you a left nav pane with an autogenerated nested menu based on your `docs` file structure. Each standalone page or subsection `_index.md` or `_index.html` page in the `docs/` directory gets a top level menu item, using the link name and `weight` metadata from the page or index. To add docs to a subsection, just add your page files to the relevant subdirectory. Any pages that you add to a subsection in addition to the subsection index page will appear in a submenu (look to the left to see one in action!), again ordered by page `weight`. Find out more about adding Docsy's navigation metadata in [Navigation and Search](/docs/adding-content/navigation/) @@ -375,7 +374,7 @@ weight: 20 ### Organizing your blog posts -Docsy's `blog` layout also gives you a left nav menu (like the `docs` layout), and a list-type index page for your blog that's applied to `/blog/_index.md` and automatically displays snippets of all your recent posts in reverse chronological order. +Docsy's `blog` layout also gives you a left nav menu (like the `docs` layout), and a list-type index page for your blog that's applied to `/blog/_index.md` and automatically displays snippets of all your recent posts in reverse chronological order. To create different blog categories to organize your posts, create subfolders in `blog/`. For instance, in our [example site](https://github.com/google/docsy-example/tree/master/content/en/blog) we have `news` and `releases`. Each category needs to have its own `_index.md` or `_index.html` landing page file specifying the category title for it to appear properly in the left nav and top-level blog landing page. Here's the index page for `releases`: @@ -469,7 +468,7 @@ Docsy's [default page template](https://github.com/google/docsy/blob/main/layout If you've copied the example site, you already have a simple site landing page in `content/en/_index.html`. This is made up of Docsy's provided Hugo shortcode [page blocks](/docs/adding-content/shortcodes/#shortcode-blocks). -To customize the large landing image, which is in a [cover](/docs/adding-content/shortcodes/#blockscover) block, replace the `content/en/featured-background.jpg` file in your project with your own image (it can be called whatever you like as long as it has `background` in the file name). You can remove or add as many blocks as you like, as well as adding your own custom content. +To customize the large landing image, which is in a [cover](/docs/adding-content/shortcodes/#blockscover) block, replace the `content/en/featured-background.jpg` file in your project with your own image (it can be called whatever you like as long as it has `background` in the file name). You can remove or add as many blocks as you like, as well as adding your 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/adding-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. @@ -602,7 +601,7 @@ If you're creating your own site and want to add a page using this template, add ## Adding static content -You may want to serve some non-Hugo-built content along with your site: for example, if you have generated reference docs using Doxygen, Javadoc, or other doc generation tools. +You may want to serve some non-Hugo-built content along with your site: for example, if you have generated reference docs using Doxygen, Javadoc, or other doc generation tools. To add static content to be served "as-is", just add the content as a folder and/or files in your site's `static` directory. When your site is deployed, content in this directory is served at the site root path. So, for example, if you have added content at `/static/reference/cpp/`, users can access that content at `http://{server-url}/reference/cpp/` and you can link to pages in this directory from other pages at `/reference/cpp/{file name}`. @@ -655,7 +654,7 @@ disableKinds:

Note

-If you have enabled our [print feature](/docs/adding-content/print/) or otherwise specified section-level output formats in `config.toml`/`config.yaml`/`config.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 `config.toml`/`config.yaml`/`config.json` specification overrides the Hugo default [output formats](https://gohugo.io/templates/output-formats/) for sections, which are HTML and RSS. +If you have enabled our [print feature](/docs/adding-content/print/) or otherwise specified section-level output formats in `config.toml`/`config.yaml`/`config.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 `config.toml`/`config.yaml`/`config.json` specification overrides the Hugo default [output formats](https://gohugo.io/templates/output-formats/) for sections, which are HTML and RSS. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} diff --git a/userguide/content/en/docs/Best practices/site-guidance.md b/userguide/content/en/docs/Best practices/site-guidance.md index 9d3ee43c36..12a3ae65de 100644 --- a/userguide/content/en/docs/Best practices/site-guidance.md +++ b/userguide/content/en/docs/Best practices/site-guidance.md @@ -7,8 +7,8 @@ description: > --- 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! +If you're not already familiar with Hugo this page provides some useful tips and +potential gotchas for adding and editing content for your site. Feel free to add your own! ## Linking @@ -19,24 +19,3 @@ Note, however, that `ref` and `relref` links don't work with `_index` or `index` [Learn more about linking](/docs/adding-content/content/#working-with-links). -## Nested lists (Blackfriday only) - -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. - -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 -(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), -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 %}}