Getting started
Write your first Remarkd document.
Remarkd reads like plain notes and renders like a polished page. If you can write a text message, you can write Remarkd — there is nothing to install. This guide walks through the everyday syntax with live examples; each shows what you type and what you get.
Writing for a site or app that already uses Remarkd? You only need this guide. Developers wiring the parser into PHP, Go, or a JavaScript project will find install and API instructions in the project README.
Your first document
Start with a heading, write a paragraph, and add a list or a note where it helps. That is already a complete document:
Open this in the playground and change a few words to see how it responds.
The basics
Paragraphs
Lines next to each other form one paragraph. Leave a blank line to start a new one.
Headings
Begin a line with # for a top-level heading; add more # for deeper levels.
Emphasis
Wrap text to style it: **bold**, __italic__, `code`, and
~~strikethrough~~.
Lists
Start lines with - for a bullet list. Begin lines with 1., 2., … for
a numbered list. Add [ ] or [x] for checkable tasks.
Links
Write a link as [label](url).
Adding structure
Notes & callouts
Lead a line with a label such as NOTE:, TIP:, or WARNING: to draw the
reader's attention.
Quotes
Wrap text in lines of four underscores to set it apart as a quote.
Code
Fence commands or code in triple backticks to keep them exactly as typed.
Tables
Open and close a table with |===. The first row is the header; separate data rows with a blank
line. A .Title line above names the table.
How blocks fit together
Two simple rules explain most of Remarkd. Blank lines separate blocks — that is how the
parser knows where a paragraph, list, or quote ends. And two one-line prefixes decorate the next
block: a line starting with a dot gives it a title, and a bracketed line such as
[.lead] adds a styling role.
That is enough to write real documents. When you want the deeper model, read the Concepts guide.