mm-docs VS remark

I am glad to know there are those that put so much thought into documentation. Documentations is just another service, and deserves all the same methodology: CI/CD, tests, components, reuse etc.

As far as I can see, you can get similar workflow with combination of existing tools. I created this docker image that combines them for very easy consumption and created thousands of pages of technical, functional and user documentation with it:

https://github.com/majkinetor/mm-docs

This plugin is built as an extension for remark, a powerful Markdown processor. When used in conjunction with react-remark (a library for rendering Markdown as React components), remark-react-liquid-tag parses your Markdown for these special liquid tags.

Processes and Chunks Content: Using tools like gray-matter and remark (with strip-markdown), the plugin extracts frontmatter (such as titles and tags) and converts the Markdown into plain text. Then it splits this content into manageable chunks (with configurable maximum chunk size) while preserving metadata like file paths.

Both Remark and Rehype are frameworks to transform documents by first transforming them to abstract syntax trees (AST) and then applying pluggable functions to the AST before converting it to the target format.

remarkjs/remark: markdown processor powered by plugins part of the @unifiedjs collective

I also didn't try this tool but it's called RemarkJS which is named too similar to revealjs.

remark. Primarily, this is a linter for Markdown. Additionally, thanks to its numerous plugins, it allows us to perform additional checks for grammatical mistakes within the content itself. Before using this linter, our content was not scrutinized to this extent.

Rehype and Remark are plugins used to transform and manipulate the HTML and Markdown content of a website, helping to enhance its functionality and appearance.

I usually combine remark-parse, remark-rehype and rehype-react to transform markdown into react components. The configuration of the processor is like:

Astro content collection are as simple as a folder containing a bunch of Markdown (or Markdoc or MDX) files if that's the only thing you need, but they can also do relationship matching between different collections, frontmatter validation using zod and you can also customize how the markdown is parsed and translated to html using rehype and remark and their plugin ecosystem.

On my personal blog I have few external links in my posts. I wanted to keep people on my website by applying target="_blank" on external (those what don't reference to my site) links. This is a common and good practice too. I write my content in Markdown, so I decided to write a remark plugin. It is simple to implement, just few lines of code.