unified

Learn

unified is an interface for parsing, inspecting, transforming, and serializing content through syntax trees. And it’s hundreds of building blocks for working on those trees.

This section of our website includes several articles ranging from recipes that complete small, specific tasks, to guides that walk through how to complete bigger tasks.

Guides

Learn unified through articles, each telling a story, that walks through how to complete a certain task

  1. Intro to unified

    Guide that summarizes the what and why of unified

    1. guide
    2. introduction
    3. welcome
    1. Merlijn Vos

  2. Use unified

    Guide that delves into transforming markdown to HTML

    1. guide
    2. rehype
    3. remark
    4. transform
    5. use
    1. Titus Wormer

  3. Create an editor

    Guide that shows how to create a fancy app ✨

    1. guide
    2. dingus
    3. editor
    4. playground
    1. Titus Wormer

  4. Syntax trees in TypeScript

    Guide that shows how to use types to work with syntax trees

    1. guide
    2. hast
    3. mdast
    4. nlcst
    5. node
    6. typescript
    7. types
    8. unist
    9. xast
    1. Christian Murphy

  5. Using plugins

    How to use plugins and presets

    1. guide
    2. plugin
    3. preset
    4. unified
    5. use
    1. Titus Wormer

  6. unified in the browser

    How to use unified in the browser

    1. guide
    2. browser
    3. dom
    4. esbuild
    5. hast
    6. mdast
    7. nlcst
    8. rehype
    9. remark
    10. retext
    11. unified
    12. web
    1. Titus Wormer

  7. Create a retext plugin

    Guide that shows how to create a retext plugin

    1. guide
    2. nlcst
    3. plugin
    4. retext
    1. Titus Wormer

  8. Create a remark plugin

    Guide that shows how to create a remark plugin

    1. guide
    2. mdast
    3. plugin
    4. remark
    1. Titus Wormer

  9. Create a rehype plugin

    Guide that shows how to create a rehype plugin

    1. guide
    2. hast
    3. plugin
    4. rehype
    1. Titus Wormer

  10. Intro to syntax trees

    Guide that shows the basics of syntax trees (ASTs)

    1. guide
    2. syntax tree
    3. unist
    1. Titus Wormer

  11. Publish a plugin

    Guide that shows how to share a plugin with the world.

    1. guide
    2. plugin
    3. rehype
    4. remark
    5. retext
    6. unified
    7. publish
    1. Titus Wormer

Recipes

Learn unified through byte-sized articles, that stand on their own, explaining how to complete a small, specific, focussed task

  1. Tree traversal

    How to do tree traversal (also known as walking or visiting a tree)

    1. recipe
    2. traverse
    3. tree
    4. unist
    5. visit
    6. walk
    1. Titus Wormer

  2. Find a node

    How to find a node in any unist syntax tree

    1. recipe
    2. find
    3. node
    4. traverse
    5. tree
    6. walk
    1. Merlijn Vos

  3. Support tables in remark

    How to support GitHub-style tables in remark (or react-markdown)

    1. recipe
    2. gfm
    3. github
    4. plugin
    5. remark
    6. table
    1. Titus Wormer

  4. HTML and remark

    How to use remark to turn markdown into HTML, and to allow embedded HTML inside markdown

    1. recipe
    2. html
    3. markdown
    4. parse
    5. plugin
    6. remark
    1. Titus Wormer

  5. Remove a node

    How to remove nodes in any unist tree

    1. recipe
    2. delete
    3. node
    4. remove
    5. traverse
    6. tree
    7. walk
    1. Titus Wormer

  6. Build a syntax tree

    How to build content with syntax trees

    1. recipe
    2. esast
    3. hast
    4. mdast
    5. nlcst
    6. unist
    7. xast
    1. Christian Murphy

  7. Tree traversal with TypeScript

    How to do tree traversal in TypeScript

    1. recipe
    2. traverse
    3. tree
    4. typescript
    5. unist
    1. Christian Murphy

  8. Narrow nodes in TypeScript

    How to narrow generic `Node` to specific syntax types

    1. recipe
    2. node
    3. typescript
    4. unist
    1. Christian Murphy

Explore

The readmes of our projects and packages, available through the Explore section of our website (or on GitHub and npm), describe the APIs and more in detail.