mirror of
https://github.com/tchartron/blow
synced 2024-11-25 13:50:23 +00:00
update
This commit is contained in:
parent
92ad56f0d3
commit
2be1377add
11 changed files with 634 additions and 3 deletions
8
content/_index.md
Normal file
8
content/_index.md
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
+++
|
||||||
|
title = "Website title"
|
||||||
|
description = "Personnal blog"
|
||||||
|
date = 2021-11-12
|
||||||
|
+++
|
||||||
|
|
||||||
|
Main page content
|
||||||
|
|
8
content/blog/_index.md
Normal file
8
content/blog/_index.md
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
+++
|
||||||
|
title = "Blog"
|
||||||
|
description = "Blog posts"
|
||||||
|
template = "section.html"
|
||||||
|
page_template = "page.html"
|
||||||
|
sort_by = "date"
|
||||||
|
paginate_by = 5
|
||||||
|
+++
|
9
content/blog/first.md
Normal file
9
content/blog/first.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
+++
|
||||||
|
title = "My first post"
|
||||||
|
date = 2021-11-12
|
||||||
|
[taxonomies]
|
||||||
|
categories=["blog"]
|
||||||
|
tags=["post", "blog"]
|
||||||
|
+++
|
||||||
|
|
||||||
|
This is my first updated blog post.
|
9
content/blog/fourth.md
Normal file
9
content/blog/fourth.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
+++
|
||||||
|
title = "My fourth post"
|
||||||
|
date = 2021-11-12
|
||||||
|
[taxonomies]
|
||||||
|
categories=["blog"]
|
||||||
|
tags=["post", "blog"]
|
||||||
|
+++
|
||||||
|
|
||||||
|
This is my fourth updated blog post.
|
9
content/blog/second.md
Normal file
9
content/blog/second.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
+++
|
||||||
|
title = "My second post"
|
||||||
|
date = 2021-11-12
|
||||||
|
[taxonomies]
|
||||||
|
categories=["blog"]
|
||||||
|
tags=["post", "blog"]
|
||||||
|
+++
|
||||||
|
|
||||||
|
This is my second updated blog post.
|
9
content/blog/seventh.md
Normal file
9
content/blog/seventh.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
+++
|
||||||
|
title = "My seventh post"
|
||||||
|
date = 2021-11-12
|
||||||
|
[taxonomies]
|
||||||
|
categories=["blog"]
|
||||||
|
tags=["post", "blog"]
|
||||||
|
+++
|
||||||
|
|
||||||
|
This is my seventh updated blog post.
|
9
content/blog/sixth.md
Normal file
9
content/blog/sixth.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
+++
|
||||||
|
title = "My sixth post"
|
||||||
|
date = 2021-11-12
|
||||||
|
[taxonomies]
|
||||||
|
categories=["blog"]
|
||||||
|
tags=["post", "blog"]
|
||||||
|
+++
|
||||||
|
|
||||||
|
This is my sixth updated blog post.
|
9
content/blog/third.md
Normal file
9
content/blog/third.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
+++
|
||||||
|
title = "My thrid post"
|
||||||
|
date = 2021-11-12
|
||||||
|
[taxonomies]
|
||||||
|
categories=["blog"]
|
||||||
|
tags=["post", "blog"]
|
||||||
|
+++
|
||||||
|
|
||||||
|
This is my thrid updated blog post.
|
8
content/markdown/_index.md
Normal file
8
content/markdown/_index.md
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
+++
|
||||||
|
title = "Markdown"
|
||||||
|
description = "Markdown posts"
|
||||||
|
template = "section.html"
|
||||||
|
page_template = "page.html"
|
||||||
|
sort_by = "date"
|
||||||
|
paginate_by = 5
|
||||||
|
+++
|
553
content/markdown/markdown-syntax.md
Normal file
553
content/markdown/markdown-syntax.md
Normal file
|
@ -0,0 +1,553 @@
|
||||||
|
+++
|
||||||
|
title = "Markdown Syntax example"
|
||||||
|
date = 2021-11-12
|
||||||
|
[taxonomies]
|
||||||
|
categories=["markdown"]
|
||||||
|
tags=["markdown", "syntax", "guide"]
|
||||||
|
+++
|
||||||
|
|
||||||
|
Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
|
||||||
|
|
||||||
|
**Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it.
|
||||||
|
|
||||||
|
Some of the key benefits are:
|
||||||
|
|
||||||
|
1. Markdown is simple to learn, with minimal extra characters, so it's also quicker to write content.
|
||||||
|
2. Less chance of errors when writing in Markdown.
|
||||||
|
3. Produces valid XHTML output.
|
||||||
|
4. Keeps the content and the visual display separate, so you cannot mess up the look of your site.
|
||||||
|
5. Write in any text editor or Markdown application you like.
|
||||||
|
6. Markdown is a joy to use!
|
||||||
|
|
||||||
|
Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like!
|
||||||
|
|
||||||
|
|
||||||
|
# Headings
|
||||||
|
|
||||||
|
Headings from `h1` through `h6` are constructed with a `#` for each level:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# h1 Heading
|
||||||
|
## h2 Heading
|
||||||
|
### h3 Heading
|
||||||
|
#### h4 Heading
|
||||||
|
##### h5 Heading
|
||||||
|
###### h6 Heading
|
||||||
|
```
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<h1>h1 Heading</h1>
|
||||||
|
<h2>h2 Heading</h2>
|
||||||
|
<h3>h3 Heading</h3>
|
||||||
|
<h4>h4 Heading</h4>
|
||||||
|
<h5>h5 Heading</h5>
|
||||||
|
<h6>h6 Heading</h6>
|
||||||
|
```
|
||||||
|
|
||||||
|
# Comments
|
||||||
|
|
||||||
|
Comments should be HTML compatible.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!--
|
||||||
|
This is a comment
|
||||||
|
-->
|
||||||
|
```
|
||||||
|
|
||||||
|
Comment below should **NOT** be seen:
|
||||||
|
|
||||||
|
<!--
|
||||||
|
This is a comment
|
||||||
|
-->
|
||||||
|
|
||||||
|
# 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:
|
||||||
|
|
||||||
|
* `___`: three consecutive underscores
|
||||||
|
* `---`: three consecutive dashes
|
||||||
|
* `***`: three consecutive asterisks
|
||||||
|
|
||||||
|
The rendered output looks like this:
|
||||||
|
|
||||||
|
___
|
||||||
|
---
|
||||||
|
***
|
||||||
|
|
||||||
|
# Body
|
||||||
|
|
||||||
|
Body written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML.
|
||||||
|
|
||||||
|
So this body:
|
||||||
|
|
||||||
|
```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.
|
||||||
|
```
|
||||||
|
|
||||||
|
The HTML looks like 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>
|
||||||
|
```
|
||||||
|
|
||||||
|
A **line break** can be done with one blank line.
|
||||||
|
|
||||||
|
# Inline HTML
|
||||||
|
|
||||||
|
If you need a certain HTML tag (with a class) you can simply use HTML:
|
||||||
|
|
||||||
|
```html
|
||||||
|
Paragraph in Markdown.
|
||||||
|
|
||||||
|
<div class="class">
|
||||||
|
This is <b>HTML</b>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Paragraph in Markdown.
|
||||||
|
```
|
||||||
|
|
||||||
|
# Emphasis
|
||||||
|
|
||||||
|
## Bold
|
||||||
|
|
||||||
|
For emphasizing a snippet of text with a heavier font-weight.
|
||||||
|
|
||||||
|
The following snippet of text is **rendered as bold text**.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
**rendered as bold text**
|
||||||
|
__rendered as bold text__
|
||||||
|
```
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<strong>rendered as bold text</strong>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Italics
|
||||||
|
|
||||||
|
For emphasizing a snippet of text with italics.
|
||||||
|
|
||||||
|
The following snippet of text is _rendered as italicized text_.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
*rendered as italicized text*
|
||||||
|
_rendered as italicized text_
|
||||||
|
```
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<em>rendered as italicized text</em>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Strikethrough
|
||||||
|
|
||||||
|
In [[GFM]^(GitHub flavored Markdown)](https://github.github.com/gfm/) you can do strikethroughs.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
~~Strike through this text.~~
|
||||||
|
```
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<del>Strike through this text.</del>
|
||||||
|
```
|
||||||
|
|
||||||
|
# Blockquotes
|
||||||
|
|
||||||
|
For quoting blocks of content from another source within your document.
|
||||||
|
|
||||||
|
Add `>` before any text you want to quote:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this:
|
||||||
|
|
||||||
|
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<blockquote>
|
||||||
|
<p>
|
||||||
|
<strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
|
||||||
|
</p>
|
||||||
|
</blockquote>
|
||||||
|
```
|
||||||
|
|
||||||
|
Blockquotes can also be nested:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
|
||||||
|
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
||||||
|
>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
|
||||||
|
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this:
|
||||||
|
|
||||||
|
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
|
||||||
|
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
||||||
|
>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
|
||||||
|
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
||||||
|
|
||||||
|
# Lists
|
||||||
|
|
||||||
|
## Unordered
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
* valid bullet
|
||||||
|
- valid bullet
|
||||||
|
+ valid bullet
|
||||||
|
```
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
* Lorem ipsum dolor sit amet
|
||||||
|
* Consectetur adipiscing elit
|
||||||
|
* Integer molestie lorem at massa
|
||||||
|
* Facilisis in pretium nisl aliquet
|
||||||
|
* Nulla volutpat aliquam velit
|
||||||
|
* Phasellus iaculis neque
|
||||||
|
* Purus sodales ultricies
|
||||||
|
* Vestibulum laoreet porttitor sem
|
||||||
|
* Ac tristique libero volutpat at
|
||||||
|
* Faucibus porta lacus fringilla vel
|
||||||
|
* Aenean sit amet erat nunc
|
||||||
|
* Eget porttitor lorem
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this:
|
||||||
|
|
||||||
|
* Lorem ipsum dolor sit amet
|
||||||
|
* Consectetur adipiscing elit
|
||||||
|
* Integer molestie lorem at massa
|
||||||
|
* Facilisis in pretium nisl aliquet
|
||||||
|
* Nulla volutpat aliquam velit
|
||||||
|
* Phasellus iaculis neque
|
||||||
|
* Purus sodales ultricies
|
||||||
|
* Vestibulum laoreet porttitor sem
|
||||||
|
* Ac tristique libero volutpat at
|
||||||
|
* Faucibus porta lacus fringilla vel
|
||||||
|
* Aenean sit amet erat nunc
|
||||||
|
* Eget porttitor lorem
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<ul>
|
||||||
|
<li>Lorem ipsum dolor sit amet</li>
|
||||||
|
<li>Consectetur adipiscing elit</li>
|
||||||
|
<li>Integer molestie lorem at massa</li>
|
||||||
|
<li>Facilisis in pretium nisl aliquet</li>
|
||||||
|
<li>Nulla volutpat aliquam velit
|
||||||
|
<ul>
|
||||||
|
<li>Phasellus iaculis neque</li>
|
||||||
|
<li>Purus sodales ultricies</li>
|
||||||
|
<li>Vestibulum laoreet porttitor sem</li>
|
||||||
|
<li>Ac tristique libero volutpat at</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Faucibus porta lacus fringilla vel</li>
|
||||||
|
<li>Aenean sit amet erat nunc</li>
|
||||||
|
<li>Eget porttitor lorem</li>
|
||||||
|
</ul>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Ordered
|
||||||
|
|
||||||
|
A list of items in which the order of items does explicitly matter.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
1. Lorem ipsum dolor sit amet
|
||||||
|
2. Consectetur adipiscing elit
|
||||||
|
3. Integer molestie lorem at massa
|
||||||
|
4. Facilisis in pretium nisl aliquet
|
||||||
|
5. Nulla volutpat aliquam velit
|
||||||
|
6. Faucibus porta lacus fringilla vel
|
||||||
|
7. Aenean sit amet erat nunc
|
||||||
|
8. Eget porttitor lorem
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this:
|
||||||
|
|
||||||
|
1. Lorem ipsum dolor sit amet
|
||||||
|
2. Consectetur adipiscing elit
|
||||||
|
3. Integer molestie lorem at massa
|
||||||
|
4. Facilisis in pretium nisl aliquet
|
||||||
|
5. Nulla volutpat aliquam velit
|
||||||
|
6. Faucibus porta lacus fringilla vel
|
||||||
|
7. Aenean sit amet erat nunc
|
||||||
|
8. Eget porttitor lorem
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<ol>
|
||||||
|
<li>Lorem ipsum dolor sit amet</li>
|
||||||
|
<li>Consectetur adipiscing elit</li>
|
||||||
|
<li>Integer molestie lorem at massa</li>
|
||||||
|
<li>Facilisis in pretium nisl aliquet</li>
|
||||||
|
<li>Nulla volutpat aliquam velit</li>
|
||||||
|
<li>Faucibus porta lacus fringilla vel</li>
|
||||||
|
<li>Aenean sit amet erat nunc</li>
|
||||||
|
<li>Eget porttitor lorem</li>
|
||||||
|
</ol>
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Task Lists
|
||||||
|
|
||||||
|
Task lists allow you to create a list of items with checkboxes. To create a task list, add dashes (`-`) and brackets with a space (`[ ]`) before task list items. To select a checkbox, add an x in between the brackets (`[x]`).
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
- [x] Write the press release
|
||||||
|
- [ ] Update the website
|
||||||
|
- [ ] Contact the media
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this:
|
||||||
|
|
||||||
|
- [x] Write the press release
|
||||||
|
- [ ] Update the website
|
||||||
|
- [ ] Contact the media
|
||||||
|
|
||||||
|
# Code
|
||||||
|
|
||||||
|
## Inline Code
|
||||||
|
|
||||||
|
Wrap inline snippets of code with <code>`</code>.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
In this example, `<section></section>` should be wrapped as **code**.
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this:
|
||||||
|
|
||||||
|
In this example, `<section></section>` should be wrapped as **code**.
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<p>
|
||||||
|
In this example, <code><section></section></code> should be wrapped with <strong>code</strong>.
|
||||||
|
</p>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Indented Code
|
||||||
|
|
||||||
|
Or indent several lines of code by at least four spaces, as in:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
// Some comments
|
||||||
|
line 1 of code
|
||||||
|
line 2 of code
|
||||||
|
line 3 of code
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this:
|
||||||
|
|
||||||
|
// Some comments
|
||||||
|
line 1 of code
|
||||||
|
line 2 of code
|
||||||
|
line 3 of code
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<pre>
|
||||||
|
<code>
|
||||||
|
// Some comments
|
||||||
|
line 1 of code
|
||||||
|
line 2 of code
|
||||||
|
line 3 of code
|
||||||
|
</code>
|
||||||
|
</pre>
|
||||||
|
```
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
| Option | Description |
|
||||||
|
| ------ | ----------- |
|
||||||
|
| data | path to data files to supply the data that will be passed into templates. |
|
||||||
|
| engine | engine to be used for processing templates. Handlebars is the default. |
|
||||||
|
| ext | extension to be used for dest files. |
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this:
|
||||||
|
|
||||||
|
| Option | Description |
|
||||||
|
| ------ | ----------- |
|
||||||
|
| data | path to data files to supply the data that will be passed into templates. |
|
||||||
|
| engine | engine to be used for processing templates. Handlebars is the default. |
|
||||||
|
| ext | extension to be used for dest files. |
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Option</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>data</td>
|
||||||
|
<td>path to data files to supply the data that will be passed into templates.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>engine</td>
|
||||||
|
<td>engine to be used for processing templates. Handlebars is the default.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>ext</td>
|
||||||
|
<td>extension to be used for dest files.</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
# Links
|
||||||
|
|
||||||
|
## Basic Link
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
<https://assemble.io>
|
||||||
|
<contact@revolunet.com>
|
||||||
|
[Assemble](https://assemble.io)
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this (hover over the link, there is no tooltip):
|
||||||
|
|
||||||
|
<https://assemble.io>
|
||||||
|
|
||||||
|
<contact@revolunet.com>
|
||||||
|
|
||||||
|
[Assemble](https://assemble.io)
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<a href="https://assemble.io">https://assemble.io</a>
|
||||||
|
<a href="mailto:contact@revolunet.com">contact@revolunet.com</a>
|
||||||
|
<a href="https://assemble.io">Assemble</a>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Add a Title
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
||||||
|
```
|
||||||
|
|
||||||
|
The rendered output looks like this (hover over the link, there should be a tooltip):
|
||||||
|
|
||||||
|
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
||||||
|
|
||||||
|
The HTML looks like this:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Named Anchors
|
||||||
|
|
||||||
|
Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Table of Contents
|
||||||
|
* [Chapter 1](#chapter-1)
|
||||||
|
* [Chapter 2](#chapter-2)
|
||||||
|
* [Chapter 3](#chapter-3)
|
||||||
|
```
|
||||||
|
|
||||||
|
will jump to these sections:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Chapter 1 <a id="chapter-1"></a>
|
||||||
|
Content for chapter one.
|
||||||
|
|
||||||
|
## Chapter 2 <a id="chapter-2"></a>
|
||||||
|
Content for chapter one.
|
||||||
|
|
||||||
|
## Chapter 3 <a id="chapter-3"></a>
|
||||||
|
Content for chapter one.
|
||||||
|
```
|
||||||
|
|
||||||
|
# Footnotes
|
||||||
|
|
||||||
|
Footnotes allow you to add notes and references without cluttering the body of the document. When you create a footnote, a superscript number with a link appears where you added the footnote reference. Readers can click the link to jump to the content of the footnote at the bottom of the page.
|
||||||
|
|
||||||
|
To create a footnote reference, add a caret and an identifier inside brackets (`[^1]`). Identifiers can be numbers or words, but they can’t contain spaces or tabs. Identifiers only correlate the footnote reference with the footnote itself — in the output, footnotes are numbered sequentially.
|
||||||
|
|
||||||
|
Add the footnote using another caret and number inside brackets with a colon and text (`[^1]: My footnote.`). You don’t have to put footnotes at the end of the document. You can put them anywhere except inside other elements like lists, block quotes, and tables.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
This is a digital footnote[^1].
|
||||||
|
This is a footnote with "label"[^label]
|
||||||
|
|
||||||
|
[^1]: This is a digital footnote
|
||||||
|
[^label]: This is a footnote with "label"
|
||||||
|
```
|
||||||
|
|
||||||
|
This is a digital footnote[^1].
|
||||||
|
|
||||||
|
This is a footnote with "label"[^label]
|
||||||
|
|
||||||
|
[^1]: This is a digital footnote
|
||||||
|
[^label]: This is a footnote with "label"
|
||||||
|
|
||||||
|
# Images
|
||||||
|
|
||||||
|
Images have a similar syntax to links but include a preceding exclamation point.
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
![Minion](https://octodex.github.com/images/minion.png)
|
||||||
|
```
|
||||||
|
|
||||||
|
![Minion](https://octodex.github.com/images/minion.png)
|
||||||
|
|
||||||
|
or:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
![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:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
![Alt text][id]
|
||||||
|
```
|
||||||
|
|
||||||
|
![Alt text][id]
|
||||||
|
|
||||||
|
With a reference later in the document defining the URL location:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
||||||
|
```
|
||||||
|
|
||||||
|
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
|
@ -57,7 +57,7 @@
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
<!-- More ... Button (sidebar) -->
|
<!-- More ... Button (sidebar) -->
|
||||||
<button id="toggle-sidebar" class="hidden">
|
<button id="toggle-sidebar">
|
||||||
<svg class="w-6 h-6" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
|
<svg class="w-6 h-6" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
|
||||||
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5 12h.01M12 12h.01M19 12h.01M6 12a1 1 0 11-2 0 1 1 0 012 0zm7 0a1 1 0 11-2 0 1 1 0 012 0zm7 0a1 1 0 11-2 0 1 1 0 012 0z"></path>
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5 12h.01M12 12h.01M19 12h.01M6 12a1 1 0 11-2 0 1 1 0 012 0zm7 0a1 1 0 11-2 0 1 1 0 012 0zm7 0a1 1 0 11-2 0 1 1 0 012 0z"></path>
|
||||||
</svg>
|
</svg>
|
||||||
|
@ -123,9 +123,9 @@
|
||||||
</div>
|
</div>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
<!---------------------------- Left side menu ---------------------------->
|
<!---------------------------- Sidebar Menu ---------------------------->
|
||||||
{% if config.extra.zt.enable_sidebar %}
|
{% if config.extra.zt.enable_sidebar %}
|
||||||
<div id="sidebar" class="flex flex-col pt-6 p-2 text-2xl text-black dark:text-gray-200 bg-gray-200 dark:bg-gray-900 transform top-0 left-0 w-64 bg-white fixed h-full overflow-auto ease-in-out transition-all duration-300 z-30 shadow-2xl">
|
<div id="sidebar" class="hidden flex flex-col pt-6 p-2 text-2xl text-black dark:text-gray-200 bg-gray-200 dark:bg-gray-900 transform top-0 left-0 w-64 bg-white fixed h-full overflow-auto ease-in-out transition-all duration-300 z-30 shadow-2xl">
|
||||||
{% for item in config.extra.sidebar.items %}
|
{% for item in config.extra.sidebar.items %}
|
||||||
{% if lang == item.code %}
|
{% if lang == item.code %}
|
||||||
{% for link in item.links %}
|
{% for link in item.links %}
|
||||||
|
|
Loading…
Reference in a new issue