Introduction to Markdown

What is Markdown?

Markdown is a simple way to format text. You write plain text together with a few special characters that specify how the text should be displayed.

Markdown is easy to learn, works in any text editor, and can easily be converted into other formats such as HTML or PDF. Because of this, Markdown is widely used for documentation, note-taking, and website content. For example, this document is written in Markdown, but is displayed as HTML in your browser.

ALTES uses Markdown in several text fields and documents. Fields that support Markdown include formatting buttons and common keyboard shortcuts, but once you know the basics, it's usually faster to write Markdown directly.

If you'd like to learn more, you can find a more comprehensive guide at:

https://www.markdownguide.org/basic-syntax/

Limitations in ALTES

Markdown normally also supports HTML syntax. However, this has been disabled in ALTES for accessibility and consistency reasons.

Basic Formatting

Paragraphs and Line Breaks

New Paragraph

To create a new paragraph, leave a blank line between two blocks of text.

Example

This is the first paragraph.

This is the second paragraph.

Result

This is the first paragraph.

This is the second paragraph.

Line Break

To insert a line break without starting a new paragraph, end the line with two or more spaces before pressing Enter.

Avoid using the Tab key to create indentation or separate paragraphs.

Headings

Headings are created by placing one or more # characters at the beginning of a line.

The number of # characters determines the heading level.

Example

# Introduction

## Formatting

### Headings

Keep in mind

• Leave a blank line before and after each heading.
• Always start with a level 1 heading.
• Don't skip heading levels. For example, a level 3 heading should appear under a level 2 heading.
• If your text is displayed together with other content, ALTES automatically adjusts the heading levels.

Emphasis

Italic Text

Wrap the text in a single asterisk (*).

Example

*This text is italic.*

Result

This text is italic.

You can also italicize individual words or letters.

Example

In this word, the *i* is *i*talic.

Result

In this word, the i is italic.

Bold Text

Wrap the text in two asterisks (**).

Example

**This text is bold.**

Result

This text is bold.

Bold and Italic Text

Wrap the text in three asterisks (***).

Example

***This text is both bold and italic.***

Result

This text is both bold and italic.

Lists

Bullet Lists

Start each line with a hyphen (-) followed by a space.

Example

- Item 1
- Item 2
- Item 3

Result

• Item 1
• Item 2
• Item 3

Keep in mind

• Leave a blank line before and after the list.
• Do not leave blank lines between list items.

Numbered Lists

Start each line with a number followed by a period and a space.

Example

1. First item
2. Second item
3. Third item

Result

1. First item
2. Second item
3. Third item

As with bullet lists, leave a blank line before and after the list.

Blockquotes

Blockquotes are used to highlight quotations or other text that should stand out from the surrounding content.

Start each line with a greater-than sign (>) followed by a space.

Example

> This is a blockquote.
>
> It contains two paragraphs.

Result

This is a blockquote.

It contains two paragraphs.

Keep in mind

• Leave a blank line before and after the blockquote.
• If the blockquote contains multiple paragraphs, the blank lines should also begin with >.

Summary