(Grav GitSync) Automatic Commit from cryhavocstudio
This commit is contained in:
cryhavocstudio
GitSync
parent
86a8346102
commit
eac50a59e4
7 changed files with 0 additions and 963 deletions
|
|
@ -1,716 +0,0 @@
|
||||||
---
|
|
||||||
title: Overview
|
|
||||||
taxonomy:
|
|
||||||
category: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
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!
|
|
||||||
|
|
||||||
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.
|
|
||||||
> -- <cite>John Gruber</cite>
|
|
||||||
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:
|
|
||||||
|
|
||||||
>>> <i class="fa fa-bookmark"></i> Bookmark this page for easy future reference!
|
|
||||||
|
|
||||||
## 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
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
# h1 Heading
|
|
||||||
## h2 Heading
|
|
||||||
### h3 Heading
|
|
||||||
#### h4 Heading
|
|
||||||
##### h5 Heading
|
|
||||||
###### h6 Heading
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```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>
|
|
||||||
```
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
## Comments
|
|
||||||
|
|
||||||
Comments should be HTML compatible
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!--
|
|
||||||
This is a comment
|
|
||||||
-->
|
|
||||||
```
|
|
||||||
Comment below should **NOT** be seen:
|
|
||||||
|
|
||||||
<!--
|
|
||||||
This is a comment
|
|
||||||
-->
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
||||||
renders to:
|
|
||||||
|
|
||||||
___
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
|
|
||||||
## Body Copy
|
|
||||||
|
|
||||||
Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML.
|
|
||||||
|
|
||||||
So this body copy:
|
|
||||||
|
|
||||||
```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.
|
|
||||||
```
|
|
||||||
renders to this HTML:
|
|
||||||
|
|
||||||
```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>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
|
|
||||||
## 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**
|
|
||||||
```
|
|
||||||
renders to:
|
|
||||||
|
|
||||||
**rendered as bold text**
|
|
||||||
|
|
||||||
and this HTML
|
|
||||||
|
|
||||||
```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_
|
|
||||||
```
|
|
||||||
|
|
||||||
renders to:
|
|
||||||
|
|
||||||
_rendered as italicized text_
|
|
||||||
|
|
||||||
and this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<em>rendered as italicized text</em>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### strikethrough
|
|
||||||
In GFM (GitHub flavored Markdown) you can do strikethroughs.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
~~Strike through this text.~~
|
|
||||||
```
|
|
||||||
Which renders to:
|
|
||||||
|
|
||||||
~~Strike through this text.~~
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<del>Strike through this text.</del>
|
|
||||||
```
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
> **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.
|
|
||||||
|
|
||||||
and this HTML:
|
|
||||||
|
|
||||||
```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.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
> 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.
|
|
||||||
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
## Notices
|
|
||||||
|
|
||||||
We have four notice styles and they extend the standard markdown syntax for block quotes. Basically levels of 3 block quote or greater produce notices in 4 colors:
|
|
||||||
|
|
||||||
### Yellow
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
>>> 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.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
>>> 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.
|
|
||||||
|
|
||||||
### Red
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
>>>> 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.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
>>>> 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.
|
|
||||||
|
|
||||||
### Blue
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
>>>>> 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.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
>>>>> 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.
|
|
||||||
|
|
||||||
### Green
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
>>>>>> 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.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
>>>>>> 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.
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
|
|
||||||
## 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
|
|
||||||
```
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
+ 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
|
|
||||||
|
|
||||||
And this HTML
|
|
||||||
|
|
||||||
```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
|
|
||||||
```
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
And this HTML:
|
|
||||||
|
|
||||||
```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>
|
|
||||||
```
|
|
||||||
|
|
||||||
**TIP**: If you just use `1.` for each number, Markdown will automatically number each item. For example:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
1. Lorem ipsum dolor sit amet
|
|
||||||
1. Consectetur adipiscing elit
|
|
||||||
1. Integer molestie lorem at massa
|
|
||||||
1. Facilisis in pretium nisl aliquet
|
|
||||||
1. Nulla volutpat aliquam velit
|
|
||||||
1. Faucibus porta lacus fringilla vel
|
|
||||||
1. Aenean sit amet erat nunc
|
|
||||||
1. Eget porttitor lorem
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
|
|
||||||
## Code
|
|
||||||
|
|
||||||
### Inline code
|
|
||||||
Wrap inline snippets of code with `` ` ``.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
In this example, `<section></section>` should be wrapped as **code**.
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
In this example, `<section></section>` should be wrapped with **code**.
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```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:
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
// Some comments
|
|
||||||
line 1 of code
|
|
||||||
line 2 of code
|
|
||||||
line 3 of code
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
// Some comments
|
|
||||||
line 1 of code
|
|
||||||
line 2 of code
|
|
||||||
line 3 of code
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<pre>
|
|
||||||
<code>
|
|
||||||
// Some comments
|
|
||||||
line 1 of code
|
|
||||||
line 2 of code
|
|
||||||
line 3 of code
|
|
||||||
</code>
|
|
||||||
</pre>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Block code "fences"
|
|
||||||
|
|
||||||
Use "fences" ```` ``` ```` to block in multiple lines of code.
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
``` markup
|
|
||||||
Sample text here...
|
|
||||||
```
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
Sample text here...
|
|
||||||
```
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<pre>
|
|
||||||
<code>Sample text here...</code>
|
|
||||||
</pre>
|
|
||||||
```
|
|
||||||
|
|
||||||
### 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. For example, to apply syntax highlighting to JavaScript code:
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
```js
|
|
||||||
grunt.initConfig({
|
|
||||||
assemble: {
|
|
||||||
options: {
|
|
||||||
assets: 'docs/assets',
|
|
||||||
data: 'src/data/*.{json,yml}',
|
|
||||||
helpers: 'src/custom-helpers.js',
|
|
||||||
partials: ['src/partials/**/*.{hbs,md}']
|
|
||||||
},
|
|
||||||
pages: {
|
|
||||||
options: {
|
|
||||||
layout: 'default.hbs'
|
|
||||||
},
|
|
||||||
files: {
|
|
||||||
'./': ['src/templates/pages/index.hbs']
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
```
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
```js
|
|
||||||
grunt.initConfig({
|
|
||||||
assemble: {
|
|
||||||
options: {
|
|
||||||
assets: 'docs/assets',
|
|
||||||
data: 'src/data/*.{json,yml}',
|
|
||||||
helpers: 'src/custom-helpers.js',
|
|
||||||
partials: ['src/partials/**/*.{hbs,md}']
|
|
||||||
},
|
|
||||||
pages: {
|
|
||||||
options: {
|
|
||||||
layout: 'default.hbs'
|
|
||||||
},
|
|
||||||
files: {
|
|
||||||
'./': ['src/templates/pages/index.hbs']
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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. |
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to:
|
|
||||||
|
|
||||||
| 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. |
|
|
||||||
|
|
||||||
And this HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th>Option</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
<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>
|
|
||||||
</table>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Right aligned text
|
|
||||||
|
|
||||||
Adding a colon on the right side of the dashes below any heading will right align text for that column.
|
|
||||||
|
|
||||||
```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. |
|
|
||||||
```
|
|
||||||
|
|
||||||
| 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. |
|
|
||||||
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
### Basic link
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
[Assemble](http://assemble.io)
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to (hover over the link, there is no tooltip):
|
|
||||||
|
|
||||||
[Assemble](http://assemble.io)
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<a href="http://assemble.io">Assemble</a>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Add a title
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
|
||||||
```
|
|
||||||
|
|
||||||
Renders to (hover over the link, there should be a tooltip):
|
|
||||||
|
|
||||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
|
||||||
|
|
||||||
HTML:
|
|
||||||
|
|
||||||
```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.
|
|
||||||
```
|
|
||||||
**NOTE** that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.
|
|
||||||
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
|
|
||||||
## Images
|
|
||||||
Images have a similar syntax to links but include a preceding exclamation point.
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
or
|
|
||||||
```markdown
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
[id]: http://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
|
||||||
|
|
||||||
|
|
||||||
[id]: http://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
|
||||||
|
|
@ -1,58 +0,0 @@
|
||||||
---
|
|
||||||
title: Sub-Sub-Topic
|
|
||||||
taxonomy:
|
|
||||||
category: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
Lorem markdownum profundo et [bellum sonarent](http://omfgdogs.com/), est cum
|
|
||||||
Circes nisi quoque pulchra demersit et! Habebas manuque tamen, innumeras solis
|
|
||||||
successurumque Horis superare Cepheusque pars pericula [vultus
|
|
||||||
hanc](http://html9responsiveboilerstrapjs.com/), dextera esse fronti. Sedes
|
|
||||||
lumina!
|
|
||||||
|
|
||||||
host_icmp_dfs = hostMysqlIt(port_portal_boolean, -1 / rateXml, dvd);
|
|
||||||
vleCrossplatformWins = barUddi + keystroke_im + adc + kilobyte_cdma(99,
|
|
||||||
fpuDiskDynamic);
|
|
||||||
signature_dns_aix -= cpu_scalable_web(memorySpyware);
|
|
||||||
|
|
||||||
Corpus nam sensit onerataque crinem imitatus nostris, adsternunturque retro nec
|
|
||||||
consumpta inponit. Fessa dubium longi. Cuncta visis caput ultra quantaque
|
|
||||||
incursant cupressus secundo posses. Nudumque bracchia canamus: ingratus dabitur
|
|
||||||
ligari dixerat tempora; **iuppiter est enim**. Ostendunt ab genitor profectu
|
|
||||||
pestiferos sed, [nondum frugilegas Libycas](http://heeeeeeeey.com/).
|
|
||||||
|
|
||||||
var malware_qwerty = ram + backlinkNewbieCard + formula + management(25);
|
|
||||||
publishing(softwareAssociationSaas, integer_row_sequence + linkLog);
|
|
||||||
var menu = autoresponder_servlet;
|
|
||||||
file_personal_proxy(fileImpression / rdfKilobitManet(task_multi_desktop,
|
|
||||||
file, 2));
|
|
||||||
domain_big.rdram(rom);
|
|
||||||
|
|
||||||
## Laniata iam Saturnia
|
|
||||||
|
|
||||||
Antium tela, matris deam, postquam et [gnatae](http://www.uselessaccount.com/)
|
|
||||||
metuit felix maestis! Esse et mente clamavit *sive fuit*? Ego et sitim.
|
|
||||||
|
|
||||||
metal = multiSubnet(disk_recycle.piracySwipeHome(core_expansion,
|
|
||||||
inboxSdk.staticPop(controlCps)), cellWheel + css(
|
|
||||||
coreAutoresponderCyberspace),
|
|
||||||
officeDatabaseProgram.bespokeHypermediaNamespace(homeTutorial,
|
|
||||||
windows, fiber_dlc_host - mmsTag));
|
|
||||||
apple_oop += vaporware_trash_wireless + d_syn(cable_memory - on,
|
|
||||||
phreaking_hypertext(arraySdkHorse, shellGigabyte));
|
|
||||||
java_blacklist_reader(screenshot_meta_crm);
|
|
||||||
var clobRepeater = memory_runtime_gui;
|
|
||||||
if (515890 - slashdot_rj * powerCybersquatter) {
|
|
||||||
sourceBoxSkyscraper(ssid_ethics / seoChip);
|
|
||||||
defragment -= configurationFileNoc(2);
|
|
||||||
real_digital.unmountNullBare += 5;
|
|
||||||
}
|
|
||||||
|
|
||||||
Summo qui deum, **referunt renascitur contra**, fortibus venabula temptat
|
|
||||||
contigit columnae sacra terga membra naides soporis **meus** corpus. Munere et
|
|
||||||
una matre arbore potest tabulas, loca tamen cuncta at locum, sua aut Pentheus,
|
|
||||||
*penates*. Puellae altera simulac, gaudia dum officium truncoque pruinae
|
|
||||||
contigit ambos Maera esset virga se, vertunt requiemque etenim, in.
|
|
||||||
|
|
||||||
Ne Priamus temptemus silvarum. Opem Pittheus monitae amplexumque rogis, inter
|
|
||||||
aut convulso videt in Cypro his Tisiphone geminae, foret!
|
|
||||||
|
|
@ -1,63 +0,0 @@
|
||||||
---
|
|
||||||
title: Sub-Topic
|
|
||||||
taxonomy:
|
|
||||||
category: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
Lorem markdownum penna; aras cetera revocatus quidem frigus in. Ut natum
|
|
||||||
surdaeque *quid*. Volandi viam iter fugae et hic quod quid, opus pete Phaethusa.
|
|
||||||
|
|
||||||
- Laevum ritusque
|
|
||||||
- Ponat dea fuit mollitaque
|
|
||||||
- Saepe tempora miserrima late duxerat quoque coniugialia
|
|
||||||
- Corpore sua iam reversurum agros visa peregrina
|
|
||||||
|
|
||||||
## Praesentia duobus si inplicuit sternebat aguntur urbes
|
|
||||||
|
|
||||||
Invisi sororum honorque: recursus corpore est flammaque corporeasque magno, dis.
|
|
||||||
Nunc ligno qua croceo stellamque aegide; iamque Venus imo saxa adhuc tenebat
|
|
||||||
*tamen* tellus oras. Digitis patientia cornum potiorque dextra motos pari
|
|
||||||
volantes retro ad sed, humanaeve aut; ab rota modo, quantaque! Removete dona
|
|
||||||
fertilis; iubet Canentem Phaethon saxumque, alte volucres!
|
|
||||||
|
|
||||||
rw_horizontal.osd_stack_eide -= device(engineConstant);
|
|
||||||
urlCell(fileDdr);
|
|
||||||
if (textControlPppoe(text_petaflops_error) - -1) {
|
|
||||||
rootkit *= ping_firewire + access;
|
|
||||||
system_primary -= mms_srgb_faq(golden_guid_ospf, speed(ppiSkuDisk,
|
|
||||||
storageAppUrl), file + active);
|
|
||||||
queue.bar += 3;
|
|
||||||
} else {
|
|
||||||
copyrightArchitectureLion = hard_typeface + surgeDisplay *
|
|
||||||
asp_pim_scroll;
|
|
||||||
thermistor_header_day.mirror_uml = blogTSpeed.json_address_honeypot(ttl,
|
|
||||||
hubIcq(1));
|
|
||||||
dragFloppy += botMacWavelength.protector_wavelength(d_youtube);
|
|
||||||
}
|
|
||||||
var number = key.png_uat.systemFirmware(fpuModemPerl + -4) -
|
|
||||||
promptDriveDrive.hardDomain(cardVariableMini);
|
|
||||||
|
|
||||||
## Pelagi illa est et et quod
|
|
||||||
|
|
||||||
Hic lacrimis [caput](http://jaspervdj.be/) est consilii, sanguine luctus
|
|
||||||
gemitusque blandis. Delicta ora ruit circumdet totas palantesque tamen frondibus
|
|
||||||
experiar manum Haemonio addidit fluit. Ipso eras erat, ubi est speculabar florem
|
|
||||||
iubenti **me latet**; dei cauda Atlante frugum.
|
|
||||||
|
|
||||||
1. Viso cum
|
|
||||||
2. Manant diris
|
|
||||||
3. Enim adverso Talia et interea iurares
|
|
||||||
4. Hoc iussit meruisse suum e gerit sub
|
|
||||||
5. Sicelidas ait
|
|
||||||
|
|
||||||
Flectat fatorum nusquam spernimur cumulum alis flaventibus modo mater felix
|
|
||||||
induruit feri et *postes*, velle! Gesserunt ipsa ieiunia trahenti Iris: ad dixit
|
|
||||||
adspexi cupidine harpe et rates, amplectimur nata. Spargit te laedere nec;
|
|
||||||
remisit pars reppulit. Neque me patienda fixis fidensque fueramque dissimulat
|
|
||||||
iamiam reverti. Sed hic aut Phorbantis
|
|
||||||
[optas](http://www.thesecretofinvisibility.com/), luctus nunc glandes miremur
|
|
||||||
qui sumpto, subit.
|
|
||||||
|
|
||||||
Ab adesse dixit data habet altera rotae et stirpes vivacem. Natalis quam? Nunc
|
|
||||||
eunt [Venusque](http://twitter.com/search?q=haskell) facit Teucri, nec vestes,
|
|
||||||
nova percutiens confertque Minyis?
|
|
||||||
|
|
@ -1,42 +0,0 @@
|
||||||
---
|
|
||||||
title: Requirements
|
|
||||||
taxonomy:
|
|
||||||
category: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
Lorem markdownum pius. Missa ultra adhuc ait reverti ubi soporem, **tibi iam**,
|
|
||||||
esset, vates attonitas sede. Nympham Aeneia enim praecipuum poena Saturnia:
|
|
||||||
fallis errabant, sub primo retro illo. Caesariem tincta natam contineat demens.
|
|
||||||
*Si sed* ardescunt Delphice quasque alteraque servant.
|
|
||||||
|
|
||||||
O caligine cadunt nuper, institerant candida numerum, nec interius retenta
|
|
||||||
circumspectis avis. Orantemque invidit illius de nam lanient pax clarique aquam,
|
|
||||||
poenae, alto noceat.
|
|
||||||
|
|
||||||
## Percussae oculos
|
|
||||||
|
|
||||||
Defendentia **flammas mundi salutem** fraudate, non munus revirescere tamen,
|
|
||||||
imago? Ad sit festumque [super](http://hipstermerkel.tumblr.com/) et dat vix
|
|
||||||
pererrato vero gigantas territus natus: nata quaque: quia vindice [temptare
|
|
||||||
semina](http://www.lipsum.com/)! Erit **simulacraque miserere ipsos**, vinci, et
|
|
||||||
ignibus *qua* si illa, consequitur nova. Constitit habet coniugis; coegit nostri
|
|
||||||
in fuissem!
|
|
||||||
|
|
||||||
Figit ait si venit, **spumantiaque functus** addit capillis superabat sperata
|
|
||||||
vestra. In nymphas cervus eram feret lingua, hunc, nulla quae. Gens *artisque*
|
|
||||||
ad peregit nitido cursu pondere. Petitur ex virtus, terrae infesto Circen: voce
|
|
||||||
roganti latet. Exit hydrae, expellitur onerosa gratissima iniustum Clytii
|
|
||||||
crimen.
|
|
||||||
|
|
||||||
## Pactique in quibus pariterque praebebat mare dapes
|
|
||||||
|
|
||||||
Sonat timeam furori non Sigei furiali os ut, orbe! Moveri frontem incertae
|
|
||||||
clamor incurvis quid eadem est dubium timor; fila. Suos *trepidaeque* cornua
|
|
||||||
sparsus.
|
|
||||||
|
|
||||||
Mihi [aut palustribus](http://www.billmays.net/), natus semilacerque audito
|
|
||||||
Enaesimus, fuerat refert. Aevi et evadere potentior Pergama sis.
|
|
||||||
|
|
||||||
Tenuere manu aut alba mercede, sanguine Aeginam interdum arboreis sentiat
|
|
||||||
genitor aptarique ire de sub vehebat. Aspera sedesque, et tempus deseruere
|
|
||||||
contenta, rex interea nisi arma.
|
|
||||||
|
|
@ -1,64 +0,0 @@
|
||||||
---
|
|
||||||
title: Installation
|
|
||||||
taxonomy:
|
|
||||||
category: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
Lorem markdownum fama iusserat **sit trunca**, isto et quid dolens Aeetias.
|
|
||||||
Indice [pater in](http://www.mozilla.org/) constitit *munus* voces bidentum
|
|
||||||
officium te utrique animaeque multum dedit. Coimus premens? Flet hospes ad
|
|
||||||
nequeunt uti; sacerdotis gestit. Dis comas meum texerat frustra, saniemque
|
|
||||||
restituit ullus, vox.
|
|
||||||
|
|
||||||
Atque et [quoque](http://www.youtube.com/watch?v=MghiBW3r65M): nec **ales
|
|
||||||
aspicis** ille honorem! Et novissima facinus cursum, futura acutis. Funereum cur
|
|
||||||
guttura servati. Aberat [mersa acta](http://www.wedrinkwater.com/) primi, sed
|
|
||||||
superum.
|
|
||||||
|
|
||||||
## Agros aut
|
|
||||||
|
|
||||||
Tum limen malo tibi, corporeusque sine *Caphereus dissimiles* tecta demittit
|
|
||||||
fletus: duritia prior, amici! Terrae furibunda vini stetit illius temptamina
|
|
||||||
virtus sagacior et nunc vidi. Telae morata nulla. Quid femina Iovi bella, *in*
|
|
||||||
memorante sublimis.
|
|
||||||
|
|
||||||
## Dubita qui messoris pudet spectat inbutam est
|
|
||||||
|
|
||||||
Quoque quantum manebat huc fuerim dabimus socium in, illi fibris ore error
|
|
||||||
murmure primis, natis nunc dixi occupat. Dea rogantem fugit audet, quantoque
|
|
||||||
praeteriti illis, quamlibet teneo, ora agmen desinite, deum, desistere. Frustra
|
|
||||||
ferunt fiunt, pellem, qua saepe variarum. *Non quam* quae monte, addita
|
|
||||||
hominumque hic tenentes [praelate](http://www.metafilter.com/) venturi florentis
|
|
||||||
videtur. Est Caucason nostros *iubent serpentibus* posuit Mnemonidas ducere
|
|
||||||
cecidit flumina.
|
|
||||||
|
|
||||||
1. Sit bis ipse in ossa vocavit status
|
|
||||||
2. Et defendere
|
|
||||||
3. Quod Pallas ilia Amphrisia caecus procubuisse dixit
|
|
||||||
4. Lumina qua negaverit vaga facit gelidae forma
|
|
||||||
5. Sic decepto recordor arboris ducentem poena
|
|
||||||
6. Dea patre lacrimas quamquam
|
|
||||||
|
|
||||||
## Sed ut Nape quid coniunx oscula
|
|
||||||
|
|
||||||
Ratus quoque nostrae invenies adspiciam data Eurytidae et mora ense
|
|
||||||
[cognitus](http://landyachtz.com/): meae pariterque, **fraude pro**. In illi
|
|
||||||
aetherias quarum. Habendus medioque exponit cornua, clarum nuncupat inquit! Tuum
|
|
||||||
denique: undis pete vitamque montes, vertitur, est tibi pectus [volenti
|
|
||||||
amorem](http://news.ycombinator.com/), indicat mirum. Gangetica pennas suaque
|
|
||||||
quo vultus iter miratus conubio heros est extrahit.
|
|
||||||
|
|
||||||
> Moras hospitio, et fugit macies, locorum? A ira requievit inmani coronatis
|
|
||||||
> quis mensis: rite quater per; esse timor Pittheus traiecit colebas, nervis
|
|
||||||
> longam. Est [corpora enim ponit](http://www.billmays.net/), capillos esses.
|
|
||||||
> Anum fortis tremulis nunc infracto frontem nec. Draconum iamque *alto*, his
|
|
||||||
> ubique mox matrum demisit suo optet ad!
|
|
||||||
|
|
||||||
## Sensit multis
|
|
||||||
|
|
||||||
Ipse hic nutritaque etiam pedibus formae cernes. Nunc bibes sed pro
|
|
||||||
[ipse](http://haskell.org/), et operum et victus maneas, distincta.
|
|
||||||
|
|
||||||
Eo doluit obliquantem Phoebus amat iam fumantiaque et sidera cadet captatam
|
|
||||||
marmoris. Conantem cursuque crudelibus velut, penitusque est sinu sola fuerat
|
|
||||||
est.
|
|
||||||
|
|
@ -1,8 +0,0 @@
|
||||||
---
|
|
||||||
title: Embedded Presentation
|
|
||||||
taxonomy:
|
|
||||||
category: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
Example Embedded Presentation
|
|
||||||
[presentation="presentations/placeholder-slide"]
|
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
---
|
|
||||||
title: Basics
|
|
||||||
taxonomy:
|
|
||||||
category: docs
|
|
||||||
child_type: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
### Chapter 1
|
|
||||||
|
|
||||||
# Basics
|
|
||||||
|
|
||||||
Discover the **basic** principles
|
|
||||||
Loading…
Add table
Reference in a new issue