Markdown


No articles match the selected filter.

Headings & Emphasis

Heading are indicated with a hash.

Heading 1

# Heading 1

Heading 2

## Heading 2

Heading 3

### Heading 3

Use either bold, italics, or monospaced font styling for emphasis:

Italicized text

*Italicized text*

Bold text

**Bold text**

Identifiers and code

`Identifiers and code`

Bullets & Numbering

Markdown allows bullets and numbering to be nested.

Use bullets to list unordered items.

Bullets

  • Sentence 1.
  • Sentence 2.
    • Nested sentence 1.
    • Nested sentence 2.
      • Double nested sentence.
* Sentence 1.
* Sentence 2.
    - Nested sentence 1.
    - Nested sentence 2.
        + Double nested sentence.

Numbering

Use a numbered list for steps that should be done in order. You can number the list yourself or have Presidium do the numbering automatically:

  1. One
  2. Two
  3. Three

  4. Four
  5. Five
  6. Six
1. One
1. Two
1. Three

4. Four
5. Five
6. Six

Links

You can link to internal articles in your repository, to external articles, or even to other semantically significant text. Any text enclosed in angle brackets will be interpreted as a link. If you want to add a description, use square brackets for the description and parenthesis for the link.

Internal link: [Presidium Authors]({{site.baseurl}}/reference/front-matter/#authors)

External link: <https://github.com/SPANDigital/presidium>

Alternative: [Presidium on Github](https://github.com/SPANDigital/presidium)

Tables

In Markdown

Markdown provides a simple syntax for creating tables using hyphens and horizontal bars / pipes.

first heading second heading third heading
row 1 column 1 row 1 column 2 row 1 column 3
row 2 column 1 row 2 column 2 row 2 column 3
row 3 column 1 row 3 column 2 row 3 column 3
row 4 column 1 row 4 column 2 row 4 column 3
| first heading  | second heading | third heading  |
|----------------|----------------|----------------|
| row 1 column 1 | row 1 column 2 | row 1 column 3 |
| row 2 column 1 | row 2 column 2 | row 2 column 3 |
| row 3 column 1 | row 3 column 2 | row 3 column 3 |
| row 4 column 1 | row 4 column 2 | row 4 column 3 |

This can be simplified by removing extra spaces, hyphens, and bars.

In HTML

Markdown tables support single-line cells. For multi-line content, use an HTML table.

Heading 1 Heading 2
Single line content.
  • Multi-
  • line-
  • content.
<table>
    <thead>
        <tr>
            <th>Heading 1</th>
            <th>Heading 2</th>
        </tr>
    </thead>
    <tbody>
        <tr>
        <td> Single line content. </td>
        <td>
            <ul>
                <li>Multi-</li>
                <li>line-</li>
                <li>content.</li>
            </ul>
        </td>
        </tr>
    </tbody>
</table>

Blockquotes

Unusual content can be included in blockquotes, which always begin with a closed angle bracket. In these examples, the Bootstrap Glyphicons provided by Jekyll have been used to embellish the text.

This is a blockquote

  • List in blockquote

Note!

  • List in blockquote
> This is a blockquote
  - List in blockquote

> <span class=”glyphicon glyphicon-pushpin”/> **Note**!
  - List in blockquote

Other Examples

TODO:

http://my/url/

Decision Point:

Example:

IMPORTANT:

Glyphs List

<span class="glyphicon glyphicon-pushpin"/>
<span class="glyphicon glyphicon-list-alt"/>
<span class="glyphicon glyphicon-tags"/>
<span class="glyphicon glyphicon-knight"/>
<span class="glyphicon glyphicon-flag"/>
<span class="glyphicon glyphicon-exclamation-sign"/>

Code Blocks

To add code blocks to your content, enclose the code with three backticks. For syntax highlighting, set the language directly after the first set of backticks. Alternatively, you can indent your code / machine output to treat it as preformatted text. For single line inline code, use a single backtick.

Javascript

var N = 32;
var buffer = new ArrayBuffer(N);
```js
var N = 32;
var buffer = new ArrayBuffer(N);
```

Python

my_array = [i for i in range(0, N)]
```py
my_array = [i for i in range(0, N)]
```

C

int * my_func(int * in) {
    return in;
}
```c
int * my_func(int * in) {
    return in;
}
```

Others

Github-flavoured Markdown supports many languages for code blocks. For a full list, go to Github.


Images

Image Links

Fully Resolved

Put any images you want to include in the <project root>/media/images directory and reference them in the text. Note the exclamation point. The image path may be fully resolved:

![Image Name](/media/images/image.png)

Baseurl

Or templated using the baseurl property defined in your site config:

![Image Name]({{site.baseurl}}/media/images/image.png)

Custom Property

Or templated using a custom property defined in your site config:

images: ${site.baseurl}/media/images
![Image Name]({{site.images}}/image.png)

Captions

To include a caption, add *Caption* after an image link. For example:

![Sample Image With Caption]({{site.baseurl}}/media/images/logo.png)
*Sample Image With Caption*

Sample Image With Caption Sample Image With Caption


Tooltips

Tooltips display a short definition of an item. There are two ways to create tooltips:

  • Automatically from the Glossary
  • Via a link override

Automatic Tooltips

Automatic tooltips reference Glossary entries. If a Glossary article by the name of “Tooltips” exists, a tooltip will be available for the following item:

Tooltips

[Tooltips](# 'presidium-tooltip')

Link Override

You can use an internal article as the source of a tooltip. Presidium will use the first paragraph of the article to construct the tooltip, so you should make sure the text will work as a tooltip. Note that the text used for the demarcation of a tooltip does not need to match the article title, like this, which links to an article on templates.

[this,]({{ site.baseurl }}/best-practices/#use-article-templates 'presidium-tooltip')

© Copyright 2018 SPAN Digital

Generated on Nov 21, 2018