Dave Jarvis' Repositories

# Basic Markdown

This section outlines the basic Markdown syntax supported by {{app.title}},
including paragraphs, headers, lists, links, and more. Countless Markdown
syntax resources exist, so only a brief refresher is provided.

## Paragraphs

Paragraphs are created by separating blocks of text with one or more blank
lines.

``` markdown
This is the first paragraph.

This is the second paragraph.
```

Without a blank line, the prose will be typeset as a single paragraph.

## Headers

Headers are created using one or more hash (`#`) symbols followed by a space
and the header text. The number of hash symbols indicates the level of the
header. While not strictly necessary, adding a blank line after a header can
make the document easier to read in its plain-text format.

``` markdown
# Header level 1

## Header level 2

### Header level 3
```

In technical documents, try to limit subheading levels to maintain clarity;
usually, three levels are sufficient.

## Lists

Ordered lists use numbers followed by a period and a space. Unordered lists
use asterisks (`*`), plus signs (`+`), or hyphens (`-`) followed by a space.

### Ordered list

My preference is to use `1.` for each ordered item and let the computer
renumber them because it makes adding and removing items faster, and
guarantees that there will never be a number skipped.

``` markdown
1. First item
1. Second item
1. Third item
```

### Unordered list

My preference is to use `*` for the first level of unordered items.

``` markdown
* Item one
* Item two
* Item three
```

## Links

Create links using square brackets for the link text followed by parentheses
for the URL.

``` markdown
[Download](https://keenwrite.com)
```

## Tables

Tables use pipes (`|`) to indicate separate columns and hyphens (`-`) to mark
the header row. Markdown does not define a syntax for table footers.

``` markdown
| Column A | Column B | Column C |
|----------|----------|----------|
| Value 1  | Value 2  | Value 3  |
| Value 4  | Value 5  | Value 6  |
```

Table cell justification can be suggested using a colon (`:`) on the left,
right, or both sides (centering) of the header separator line.

``` markdown
| Column A   | Column B  |  Column C |
|:-----------|:---------:|----------:|
| Value 1    |  Value 2  |   Value 3 |
| Value 4    |  Value 5  |   Value 6 |
```

The colon location is a hint to the presentation layer, which has the
freedom to ignore it.