docs: Cleanup markdown reference page #31

This commit is contained in:
Sören Weber 2021-07-26 01:47:25 +02:00
parent c161a2c03d
commit 4b4a6bc5e2
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589

View file

@ -25,7 +25,7 @@ John Gruber, the author of Markdown, puts it like this:
Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like: Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:
{{% notice info %}} {{% notice info %}}
<i class="fas fa-bookmark"></i> Bookmark this page for easy future reference! <i class="fas fa-bookmark"></i> Bookmark this page and the [official Commonmark reference](https://commonmark.org/help/) for easy future reference!
{{% /notice %}} {{% /notice %}}
## Headings ## Headings
@ -85,19 +85,15 @@ 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 `---` - three consecutive dashes
* `___`: three consecutive underscores
* `---`: three consecutive dashes
* `***`: three consecutive asterisks
renders to: renders to:
___ ---
## Body Copy ## Paragraphs
Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML. Any text not starting with a special sign is written as normal, plain text and will be wrapped within `<p></p>` tags in the rendered HTML.
So this body copy: So this body copy:
@ -111,7 +107,7 @@ renders to this HTML:
<p>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.</p> <p>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.</p>
``` ```
## Emphasis ## Text Markers
### Bold ### Bold
@ -215,12 +211,6 @@ Renders to:
> >
> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. > Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
## Notices
{{% notice note %}}
Here is some important information: Stay hydrated!
{{% /notice %}}
## Lists ## Lists
### Unordered ### Unordered
@ -427,7 +417,7 @@ HTML:
### Syntax highlighting ### Syntax highlighting
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. GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, usually you 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.
See [Code Highlighting]({{% relref "syntaxhighlight.md" %}}) for additional documentation. See [Code Highlighting]({{% relref "syntaxhighlight.md" %}}) for additional documentation.
@ -632,7 +622,11 @@ With a reference later in the document defining the URL location:
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat" [id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
### Resizing image ### Further image formatting
The Hugo markdown parser supports additional non-standard functionality.
#### Resizing image
Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`). Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
@ -654,7 +648,7 @@ Add HTTP parameters `width` and/or `height` to the link image to resize the imag
![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px) ![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)
### Add CSS classes #### Add CSS classes
Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and `border` are available but you could define other ones. Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and `border` are available but you could define other ones.
@ -676,7 +670,7 @@ Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and
![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
Add a HTTP `featherlight` parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining `featherlight` to `false`. Add a HTTP `featherlight` parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining `featherlight` to `false`.