You can paste markdown containing YAML here, see it rendered with the YAML highlighted, and share it through a link, which is handy when a config change needs a second pair of eyes.
YAML is the language of configuration, and configuration changes are reviewed in writing. A platform engineer proposes a new CI job and explains each step. Someone compares two versions of a Kubernetes manifest before raising resource limits. A developer documents the docker-compose file a project needs locally, with notes on which services are optional. The details that matter in these reviews are small: an indentation level, a quoted versus unquoted value, a key spelled slightly wrong.
In the rendered view, keys, strings, numbers, booleans and comments have distinct colors, so a misplaced key or an accidental string is easier to notice. Explanatory text, tables of environment variables and checklists sit around the config instead of being crammed into comments.
One detail to know: a --- block at the very top of a document is read as frontmatter. Its title becomes the document title and the block is hidden from the preview, so always put the YAML you want to show inside a fenced code block. The viewer does not lint or validate the config. Anyone with the read-only link can open the page without an account, and it expires 15 days after creation. Strip secrets before sharing.
How to view YAML in markdown
- Paste your markdown into the editor above, or edit the example.
- Wrap YAML code in a fenced block that starts with ```yaml.
- The preview shows the rendered document with the code highlighted (side by side on desktop; switch to Preview on a phone).
- Select Share to get a read-only link that anyone can open without an account.
Frequently asked questions
Does the yml tag work as well?
Yes. ```yaml and ```yml are both highlighted with the YAML grammar.
Why did my YAML disappear from the preview?
A --- block at the start of the document is treated as frontmatter and hidden. Wrap the YAML in a fenced code block (```yaml) and it will be shown and highlighted.
Will it tell me if my YAML is invalid?
No. There is no linting or schema check. The preview colors the text so it is easier to read, nothing more.