Markdown
Markup with Markdown
Markdown is the lightweight, easy to learn, human-readable markup language that powers refile.
Think of markdown as a way to write text while specifying its formatting.
This is just a rough guide, for more information on markdown, please visit markdowntutorial.com.
Headings
To create headings, add pound symbols (#) at the beginning of a line, followed by a space. The number of pound symbols corresponds to the heading level:
Best Practices for Headings:
- Always include a space between the # symbols and your heading text
- Leave a blank line before and after headings for better readability
Text Formatting
Bold Text
To make text bold, add two asterisks or two underscores before and after the text:
You can also make part of a word bold using asterisks: This is a **bold** word
Italic Text
To make text italic, add one asterisk or one underscore before and after the text:
Like with bold text, you can italicize part of a word: This is an *italicized* word
Tables
Tables are created using pipes (|) and dashes (-):
This renders as:
Header 1 | Header 2 |
---|---|
Cell 1 | Cell 2 |
Cell 3 | Cell 4 |
Text Alignment in Tables
You can align text in columns by adding colons (:) to the header row:
:--
Left alignment:-:
Center alignment--:
Right alignment
Lists in Markdown
Markdown supports several types of lists to organize your content effectively:
Unordered Lists
Create unordered (bulleted) lists using hyphens, asterisks, or plus signs followed by a space:
All three methods produce the same bulleted list output, though some editors may only support hyphens (-).
Ordered Lists
Create numbered lists by starting each line with a number followed by a period and a space:
To start numbering from a specific value, use that number for the first item:
Nested Lists
Create hierarchical lists by indenting with spaces (typically 2 or 4 spaces):
Task Lists
We support task lists with checkboxes:
Example Document
Here’s a complete example that demonstrates the markdown features we’ve covered:
This example demonstrates headings of different levels, text formatting, task lists, tables with alignment, ordered and nested lists, and links - all of which were covered in the previous sections.
You can copy this example and modify it to create your own structured documents in refile.