As there has been talk of centralizing (some) of the docs and improving on helping users get started, I decided to start with writing more guides like the ones currently online and let those act as the introductory knowledge base about the ecosystem. These guides will probably get a prominent place on v2 of this website.

Any feedback is appreciated as well as ideas for new guides!

• Introduction to unified

After reading this guide you will: understand what unified does, get a taste of the ecosystem., know how it can be used, know what parts (processors) you need for your (future) use case, have a list of resources to continue learning or get started.

• Using unified

Learn how to use unified by transforming markdown to HTML. It’ll also show how to use plugins, add a table of contents, and check prose.

• Create an online editor

Learn how to create an interactive online editor with unified. This guide creates a demo visualising syntactic properties of text.

• Setting up tooling for browser support.

Learn how to setup your favorite build tool to make unified usable in the browser.

• Introduction to syntax trees with unist, mdast, hast, and nlcst

As mentioned in syntax-tree/ideas#7, this should not be writing yet another book on syntax trees, that largely duplicates existing resources. This guide should focus on getting a basic but sufficient mental model about syntax trees, how they're used in the ecosystem, and what specs like unist are.

• How to create a new syntax tree format

Learn how to make a proper specification for a content format.

• How to get started with writing plugins

This guide goes deeper into how unified and processors work under the hood and explains some common approaches. Furthermore, it goes into the pros and cons of writing a plugin at parser level or, for instance, mdast.

• Writing a hast plugin

Walk through of an example plugin with hast.

• Writing a mdast plugin

Walk through of an example plugin with mdast.

• Writing as nlcst plugin

Walk through of an example plugin with nlcst.

• Writing a remark parser plugin.

Walk through of an example parser plugin .

• vfile?

Should probably be included but not sure how yet.