remark-lint VS mdast

we first looked into Vale but are moving to Remark Lint. Both have VS Code extensions so you can have it prompt you as you work.

I want to just give a shout out to Remark which is a linter for your READMEs which makes so much sense to me. Our code should be of a consistent standard, so why not the READMEs too!

With our dependencies all installed, we can start creating a .remarkrc.js, which will contain all the plugins that will be consumed by the remark processor. For details about alternative or advanced configurations, please refer to Configuring remark-lint.

The actual splitting of the node into those 3 new nodes will depend on the type of AST node (see docs). If you look at other remark plugins, you might find examples or utils for doing that more easily.

contentlayer uses remark to parse the markdown in an mdast. We can now use remark plugins to modify the mdast. Then rehype comes into play and converts the mdast into a hast. rehype plugins can now modify the hast. Finally the hast is converted into react components.

remark parses and process the Markdown text, and converts it into an abstract syntax tree (AST). This tree is composed of unist nodes, which follow the Markdown Abstract Syntax Tree (mdast) structure.

Because we will be inspecting a mdast, which is a markdown abstract syntax tree built upon unist, we can take advantage of the many existing unist utilities to inspect our tree's nodes.