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

Fix various markdown warnings

Browse source
This commit is contained in:
Matthew Taylor 2020-06-01 13:30:02 +01:00 committed by Matthew Taylor
parent 8349d619a5
commit 9c080a39d8
1 changed files with 77 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -25,8 +25,7 @@ Some of the key benefits are:
John Gruber, the author of Markdown, puts it like this: John Gruber, the author of Markdown, puts it like this:
> The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email. > The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
> -- <cite>John Gruber</cite> > -- John Gruber
Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file
@ -50,12 +49,18 @@ Headings from `h1` through `h6` are constructed with a `#` for each level:
``` ```
Renders to: Renders to:
<!-- markdownlint-disable MD025 -->
# h1 Heading # h1 Heading
<!-- markdownlint-enable MD025 -->
## h2 Heading ## h2 Heading
### h3 Heading ### h3 Heading
#### h4 Heading #### h4 Heading
##### h5 Heading ##### h5 Heading
###### h6 Heading ###### h6 Heading
HTML: HTML:
@ -78,13 +83,13 @@ Comments should be HTML compatible
This is a comment This is a comment
--> -->
``` ```
Comment below should **NOT** be seen: Comment below should **NOT** be seen:
<!-- <!--
This is a comment This is a comment
--> -->
## Horizontal Rules ## Horizontal Rules
The HTML `<hr>` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `<hr>` with any of the following: The HTML `<hr>` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `<hr>` with any of the following:
@ -97,11 +102,6 @@ renders to:
___ ___
---
***
## Body Copy ## Body Copy
Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML. Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML.
@ -111,6 +111,7 @@ So this body copy:
```markdown ```markdown
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad. Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
``` ```
renders to this HTML: renders to this HTML:
```html ```html
@ -120,6 +121,7 @@ renders to this HTML:
## Emphasis ## Emphasis
### Bold ### Bold
For emphasizing a snippet of text with a heavier font-weight. For emphasizing a snippet of text with a heavier font-weight.
The following snippet of text is **rendered as bold text**. The following snippet of text is **rendered as bold text**.
@ -127,9 +129,12 @@ The following snippet of text is **rendered as bold text**.
```markdown ```markdown
**rendered as bold text** **rendered as bold text**
``` ```
renders to: renders to:
<!-- markdownlint-disable MD036 -->
**rendered as bold text** **rendered as bold text**
<!-- markdownlint-enable MD036 -->
and this HTML and this HTML
@ -138,6 +143,7 @@ and this HTML
``` ```
### Italics ### Italics
For emphasizing a snippet of text with italics. For emphasizing a snippet of text with italics.
The following snippet of text is _rendered as italicized text_. The following snippet of text is _rendered as italicized text_.
@ -148,7 +154,9 @@ _rendered as italicized text_
renders to: renders to:
<!-- markdownlint-disable MD036 -->
_rendered as italicized text_ _rendered as italicized text_
<!-- markdownlint-enable MD036 -->
and this HTML: and this HTML:
@ -156,13 +164,14 @@ and this HTML:
<em>rendered as italicized text</em> <em>rendered as italicized text</em>
``` ```
### strikethrough ### strikethrough
In GFM (GitHub flavored Markdown) you can do strikethroughs. In GFM (GitHub flavored Markdown) you can do strikethroughs.
```markdown ```markdown
~~Strike through this text.~~ ~~Strike through this text.~~
``` ```
Which renders to: Which renders to:
~~Strike through this text.~~ ~~Strike through this text.~~
@ -219,10 +228,10 @@ Renders to:
The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices) The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices)
{{% /notice %}} {{% /notice %}}
## Lists ## Lists
### Unordered ### Unordered
A list of items in which the order of the items does not explicitly matter. A list of items in which the order of the items does not explicitly matter.
You may use any of the following symbols to denote bullets for each list item: You may use any of the following symbols to denote bullets for each list item:
@ -249,8 +258,10 @@ For example
+ Aenean sit amet erat nunc + Aenean sit amet erat nunc
+ Eget porttitor lorem + Eget porttitor lorem
``` ```
Renders to: Renders to:
<!-- markdownlint-disable MD004 -->
+ Lorem ipsum dolor sit amet + Lorem ipsum dolor sit amet
+ Consectetur adipiscing elit + Consectetur adipiscing elit
+ Integer molestie lorem at massa + Integer molestie lorem at massa
@ -263,6 +274,7 @@ Renders to:
+ Faucibus porta lacus fringilla vel + Faucibus porta lacus fringilla vel
+ Aenean sit amet erat nunc + Aenean sit amet erat nunc
+ Eget porttitor lorem + Eget porttitor lorem
<!-- markdownlint-enable MD004 -->
And this HTML And this HTML
@ -292,14 +304,15 @@ A list of items in which the order of items does explicitly matter.
```markdown ```markdown
1. Lorem ipsum dolor sit amet 1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit 4. Consectetur adipiscing elit
3. Integer molestie lorem at massa 2. Integer molestie lorem at massa
4. Facilisis in pretium nisl aliquet 8. Facilisis in pretium nisl aliquet
5. Nulla volutpat aliquam velit 4. Nulla volutpat aliquam velit
6. Faucibus porta lacus fringilla vel 99. Faucibus porta lacus fringilla vel
7. Aenean sit amet erat nunc 21. Aenean sit amet erat nunc
8. Eget porttitor lorem 6. Eget porttitor lorem
``` ```
Renders to: Renders to:
1. Lorem ipsum dolor sit amet 1. Lorem ipsum dolor sit amet
@ -353,6 +366,7 @@ Renders to:
## Code ## Code
### Inline code ### Inline code
Wrap inline snippets of code with `` ` ``. Wrap inline snippets of code with `` ` ``.
```markdown ```markdown
@ -371,21 +385,23 @@ HTML:
### Indented code ### Indented code
Or indent several lines of code by at least four spaces, as in: Or indent several lines of code by at least two spaces, as in:
<pre>
// Some comments
line 1 of code
line 2 of code
line 3 of code
</pre>
Renders to:
```markdown
// Some comments // Some comments
line 1 of code line 1 of code
line 2 of code line 2 of code
line 3 of code line 3 of code
```
Renders to:
<!-- markdownlint-disable MD046 -->
// Some comments
line 1 of code
line 2 of code
line 3 of code
<!-- markdownlint-enable MD046 -->
HTML: HTML:
@ -400,19 +416,11 @@ HTML:
</pre> </pre>
``` ```
### Block code "fences" ### Block code "fences"
Use "fences" ```` ``` ```` to block in multiple lines of code. Use "fences" ```` ``` ```` to block in multiple lines of code.
<pre> ```markup
``` markup
Sample text here...
```
</pre>
```
Sample text here... Sample text here...
``` ```
@ -428,28 +436,28 @@ HTML:
GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code: GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
<pre> <!-- markdownlint-disable MD046 -->
```js ```js
grunt.initConfig({ grunt.initConfig({
assemble: { assemble: {
options: { options: {
assets: 'docs/assets', assets: 'docs/assets',
data: 'src/data/*.{json,yml}', data: 'src/data/*.{json,yml}',
helpers: 'src/custom-helpers.js', helpers: 'src/custom-helpers.js',
partials: ['src/partials/**/*.{hbs,md}'] partials: ['src/partials/**/*.{hbs,md}']
}, },
pages: { pages: {
options: { options: {
layout: 'default.hbs' layout: 'default.hbs'
}, },
files: { files: {
'./': ['src/templates/pages/index.hbs'] './': ['src/templates/pages/index.hbs']
}
}
} }
} };
} ```
}; <!-- markdownlint-disable MD046 -->
```
</pre>
Renders to: Renders to:
@ -475,8 +483,8 @@ grunt.initConfig({
``` ```
## Tables ## Tables
Tables are created 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.
Tables are created 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 ```markdown
| Option | Description | | Option | Description |
@ -553,8 +561,7 @@ HTML:
<a href="http://assemble.io">Assemble</a> <a href="http://assemble.io">Assemble</a>
``` ```
### Add a tooltip
### Add a title
```markdown ```markdown
[Upstage](https://github.com/upstage/ "Visit Upstage!") [Upstage](https://github.com/upstage/ "Visit Upstage!")
@ -580,6 +587,7 @@ Named anchors enable you to jump to the specified anchor point on the same page.
* [Chapter 2](#chapter-2) * [Chapter 2](#chapter-2)
* [Chapter 3](#chapter-3) * [Chapter 3](#chapter-3)
``` ```
will jump to these sections: will jump to these sections:
```markdown ```markdown
@ -600,12 +608,15 @@ Images have a similar syntax to links but include a preceding exclamation point.
```markdown ```markdown
![Minion](https://octodex.github.com/images/minion.png) ![Minion](https://octodex.github.com/images/minion.png)
``` ```
![Minion](https://octodex.github.com/images/minion.png) ![Minion](https://octodex.github.com/images/minion.png)
or or
```markdown ```markdown
![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
``` ```
![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
Like links, Images also have a footnote style syntax Like links, Images also have a footnote style syntax
@ -615,6 +626,7 @@ Like links, Images also have a footnote style syntax
```markdown ```markdown
![Alt text][id] ![Alt text][id]
``` ```
![Alt text][id] ![Alt text][id]
With a reference later in the document defining the URL location: With a reference later in the document defining the URL location:
@ -652,16 +664,19 @@ Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and
```markdown ```markdown
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow)
``` ```
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=shadow) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=shadow)
```markdown ```markdown
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border)
``` ```
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border)
```markdown ```markdown
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow)
``` ```
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border,shadow) ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border,shadow)
### Lightbox ### Lightbox