Markdown allows bullets and numbering to be nested.
Use bullets to list unordered items.
* Sentence 1.
* Sentence 2.
- Nested sentence 1.
- Nested sentence 2.
+ Double nested sentence.
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:
One
Two
Three
Four
Five
Six
1. One
1. Two
1. Three
4. Four
5. Five
6. Six
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 Page link: [Presidium Authors]({{< ref "reference/front-matter/authors.md" >}})
- Internal Anchor link: [Presidium Authors]({{< ref "reference/front-matter/#authors" >}})
- External link: <https://github.com/SPANDigital/presidium>
- Alternative: [Presidium on Github](https://github.com/SPANDigital/presidium)
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 |
Unusual content can be included in blockquotes, which always begin with a closed angle bracket. In these examples, the Bootstrap Glyphicons have been used to embellish the text.
This is a blockquote
- List in blockquote
Note!
- List in blockquote
TODO
Decision:
Example:
IMPORTANT
> **TODO**
> <span class="glyphicon glyphicon-list-alt"></span>
> <http://my/url/>
> <span class="glyphicon glyphicon-tags"></span>
> **Decision:**
> <span class="glyphicon glyphicon-knight"></span>
> **Example:**
> <span class="glyphicon glyphicon-flag"></span>
> **IMPORTANT**
> <span class="glyphicon glyphicon-exclamation-sign"></span>
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.
var N = 32;
var buffer = new ArrayBuffer(N);
```js
var N = 32;
var buffer = new ArrayBuffer(N);
```
my_array = [i for i in range(0, N)]
```py
my_array = [i for i in range(0, N)]
```
int * my_func(int * in) {
return in;
}
```c
int * my_func(int * in) {
return in;
}
```
package main
import "fmt"
func main() {
fmt.Println("hello world")
}
```go
package main
import "fmt"
func main() {
fmt.Println("hello world")
}
```
Github-flavoured Markdown supports many languages for code blocks. For a full list, go to Github.
Put any images you want to include in the
{{< img src="/images/logo.png" caption="Sample image" style="width:25%;" >}}
To include a caption, add Caption after an image link. For example:
Sample Image With Caption
*Sample Image With Caption*
Tooltips display a short definition of an item. There are two ways to create 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:
TooltipsThis is an example of a Glossary entry linked to from here.{{< tooltip "Tooltips" >}}`
You can use an internal article as the source of a tooltip. Presidium will use the first 100 words 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,Before you write any content, spend some time anticipating what tasks you need to perform and make sure you have the time and resources to achieve your goals. The following steps work for both small and large projects: Design the site structure Inventory existing content Plan the conversion of existing content into articles Map the planned articles to your structure Identify required new articles Repurpose existing content into articles Write new articles Proofread and edit Publish Discussion The most important planning task is identifying the scope of your documentation efforts and understanding the needs of your audience. Presidium is pre-configured with a set of standard sections that are commonly used in software documentation. You can use this framework when starting to scope your project. which links to an article on plan content development.
{{< tooltip "this," "best-practices/plan-content-development.md" >}}
A shortcode is available ({{% sidebyside %}}) in order to have content, within a single file, in two different columns that are side by side.
Create side-by-side content by using the following:
<div class="side-by-side">
<div style="float:left; width:50%">
Content you want on the left hand side of the site
</div>
<div style="float:right; width:50%">
Content you want on the right hand side of the site
</div>
</div>
Note:
--split-content--is where the content is to be split between left and right. Without this keyword the site will fail to render the two columns correctly