Astro M²DX - Magic MDX in Astro

DEPRECATED: Please consider using the plugin astro-m2dx, which bundles all features from the different @astro-m2dx plugins in one plugin (all features are opt-in).

This project provides an example of how magic the use of MDX in Astro can be, to create beautiful and function-rich web sites, even for non-tech editors.

The goal is, to provide content-editors with the ability to write almost clean markdown, with only a few sprinkles of JSX and without overloading the frontmatter.

The web site

The source for the web site can be found in apps/web. It tries to be a good example how MDX can be used in combination with some Astro components to create a web site.

The plugins

The plugins can be found in packages/* and will be published to NPM

The following plugins are available:

• remark-astro-auto-import - lets users define a set of components that can be used in MDX-files without explicitly being imported.
• remark-astro-auto-layout - lets users define a default layout for all MDX-pages in a directory and its subdirectories.
• remark-astro-raw-content - adds the raw markdown content to the frontmatter, to analyze in the layout, e.g. to compute reading time.
• remark-sectionize-headings - wrap headings and the following paragraphs into sections, e.g. to style them.
• vite-astro-mdx-mapping - lets users define a mapping from standard html elements to JSX components on a per-directory basis.

The following plugins are planned:

• remark-astro-title-abstract - extracts the title and abstract of a markdown file and adds it to the frontmatter title and abstract properties.
• remark-astro-import-src - imports files relative to referencing file from string src attributes.
• remark-astro-style-directive - lets users apply CSS classes to the HTML elements resulting from the markdown.
• remark-astro-mdast - adds the markdown AST (mdast) to the frontmatter, to analyze in the layout, e.g. to generate a TOC.
• remark-astro-hast - adds the HTML AST (hast) to the frontmatter, to analyze in the layout, e.g. to ???.