Remarkd language guide

Write structured documents in readable plain text.

Remarkd is a Markdown-inspired format with practical blocks for guides, product docs, references, tabbed instructions, callouts, tables, video, and source-backed notes. It stays legible as plain text and renders to clean HTML — with matching parsers in PHP, Go, and TypeScript.

Get started Open the playground Browse the reference

Human first

Source stays readable before and after rendering. No tag soup, no required tooling.

Guide ready

Notes, steps, tabs, accordions, tables, video, and references without hand-writing HTML.

Cross-language

PHP, Go, and TypeScript are tested byte-for-byte against one shared fixture suite.

Start here

Pick the path that matches what you need right now.

Getting StartedInstall and call the parser from PHP, Go, or TypeScript. ConceptsHow blocks, attributes, conditionals, and macros fit together. Feature ReferenceEvery syntax feature with a live preview and the exact HTML. PlaygroundType Remarkd and watch it render in your browser. ConformanceThe shared fixture suite and how the three parsers stay aligned. SourceRead the parsers and contribute fixtures on GitHub.

Cheat sheet

The patterns you reach for most. Full details live in the reference.

Heading# Heading
ParagraphText on one or more lines
Strong**important**
Emphasis__emphasis__
Inline code`code`
Underline___underlined___
Deleted~~deleted~~
Link[Label](https://example.com)
Autolinkhttps://example.com/docs[Docs]
Inline image![Alt](image.png "Title")
Block imageimage::diagram.png[Alt,640,480]
Unordered list- Item
Task item- [x] Done
DefinitionTerm:: Meaning
Quote block____ Quoted text ____
Code block``` code ```
Table|=== |Name |Value |A |1 |===
NoteNOTE: Remember this
Tabs_|_#first [name=First]
Accordion_-_#one [name=One]
Attribute:product: Remarkd
ReferenceFact{{ref content=Source}}

Three implementations, one spec

Every feature on this site is backed by a fixture in requirements/features: an input.remarkd source and the exact expected.html output. The PHP, Go, and TypeScript parsers all assert against the same fixtures, so behaviour cannot quietly diverge between languages. The conformance page renders every fixture and checks the TypeScript parser live in your browser.