nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 07:47:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: annouce GFM support #411

Browse source
This commit is contained in:
Sören Weber 2022-12-02 16:20:45 +01:00
parent f0930cd78f
commit 538fba4d9f
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
4 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -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

1
exampleSite/content/_index.en.md
View file

@ -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

2
exampleSite/content/basics/migration/_index.en.md
View file

@ -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

6
exampleSite/content/cont/markdown.en.md
View file

@ -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 |