From 538fba4d9f63b0c4743a245631d3e1ad4175acd3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Fri, 2 Dec 2022 16:20:45 +0100 Subject: [PATCH] docs: annouce GFM support #411 --- README.md | 1 + exampleSite/content/_index.en.md | 1 + exampleSite/content/basics/migration/_index.en.md | 2 ++ exampleSite/content/cont/markdown.en.md | 6 +++--- 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5d6e83d26b..8854155f6c 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo - Automatic next/prev buttons to navigate through menu entries - Automatic Search - Dedicated search page +- Support for GFM (GitHub Flavored Markdown) - Print whole chapters or even the complete site - Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinese, Dutch, Finnish (Suomi), French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese - Support for languages written right to left diff --git a/exampleSite/content/_index.en.md b/exampleSite/content/_index.en.md index c28edb9492..2d3d5f1a9f 100644 --- a/exampleSite/content/_index.en.md +++ b/exampleSite/content/_index.en.md @@ -23,6 +23,7 @@ See [what's new]({{% relref "basics/migration" %}}) within the latest update. - Automatic next/prev buttons to navigate through menu entries - [Automatic Search]({{%relref "basics/configuration#activate-search" %}}) - [Dedicated search page]({{%relref "basics/configuration#activate-dedicated-search-page" %}}) +- [Support for GFM]({{% relref "cont/markdown" %}}) (GitHub Flavored Markdown) - [Print]({{%relref "basics/configuration#activate-print-support" %}}) whole chapters or even the complete site - [Multilingual mode]({{%relref "cont/i18n" %}}) for English, Arabic, Simplified Chinese, Traditional Chinese, Dutch, Finnish (Suomi), French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese - Support for languages written right to left diff --git a/exampleSite/content/basics/migration/_index.en.md b/exampleSite/content/basics/migration/_index.en.md index 9795ddad89..3570b54190 100644 --- a/exampleSite/content/basics/migration/_index.en.md +++ b/exampleSite/content/basics/migration/_index.en.md @@ -18,6 +18,8 @@ This document shows you what's new in the latest release. For a detailed list of - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The new [`badge` shortcode]({{% relref "shortcodes/badge" %}}) is now available to add highly configurable markers to your content as you can see it on this page. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hudo Markdown extensions, namely [task lists]({{% relref "cont/markdown#tasks" %}}), [defintion lists]({{% relref "cont/markdown#defintions" %}}) and [footnotes]({{% relref "cont/markdown#footnotes" %}}). + --- ## 5.7.0 diff --git a/exampleSite/content/cont/markdown.en.md b/exampleSite/content/cont/markdown.en.md index 1512589204..93b205b412 100644 --- a/exampleSite/content/cont/markdown.en.md +++ b/exampleSite/content/cont/markdown.en.md @@ -127,7 +127,7 @@ I am rendered with _italicized text_ ### Strikethrough -In GFM (GitHub flavored Markdown) you can do strikethroughs by enclosing text with two tildes `~~`. +In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes `~~`. ````markdown ~~Strike through this text~~ @@ -225,7 +225,7 @@ Markdown will automatically number each of your items consecutively. This means, ### Tasks -In GFM (GitHub flavored Markdown) you can add task lists resulting in checked or unchecked non-clickable items +In GFM (GitHub Flavored Markdown) you can add task lists resulting in checked or unchecked non-clickable items ````markdown - [x] Basic Test @@ -371,7 +371,7 @@ grunt.initConfig({ ## Tables -In GFM (GitHub flavored Markdown) you can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned. +In GFM (GitHub Flavored Markdown) you can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned. ````markdown | Option | Description |