Skip to main content

Introduction to Markdown

Markdown is a way to add structure and formatting to plain text. The source stays readable while you write it, then tinymash turns it into the headings, links, lists, and other elements shown on the published page.

John Gruber released Markdown in 2004. Aaron Swartz contributed to the design of its formatting syntax. Markdown was designed to be easy to write and easy to read before conversion to HTML. tinymash uses CommonMark as its base and adds a few documented features of its own.

A small example

Write this:

## Visiting Stockholm

Bring a **warm jacket** and read the [travel notes](/travel-notes).

- Saturday: museum
- Sunday: old town

The result has a heading, bold text, a link, and a bulleted list. The Markdown source remains ordinary text.

Everyday Markdown

To create Write
A heading ## Heading
Bold text **bold text**
Italic text *italic text*
A link [link text](https://example.com)
A bulleted list - List item
A quotation > Quoted text
Inline code `code`

Leave a blank line between paragraphs. Use the media and internal-link tools when inserting managed images or links to other tinymash content.

Writing in Composer

Composer stores the Markdown shown in the Write tab. Preview shows how the current text will appear when published. The toolbar inserts common Markdown for you, so you do not need to memorize the punctuation.

tinymash also supports features that are not part of standard Markdown, including emoji shortcodes, callouts, and plugin shortcodes. The in-app Markdown reference lists the supported forms.

Continue with Composer