Ariadocs

Plugins

Edit on GitHub

The remark and rehype plugins most docs sites need.

import {
  remarkGfm,
  rehypeSlug,
  rehypeAutolinkHeadings,
  rehypeCodeTitles,
  rehypePrism,
  rehypeCodeRaw,
} from "@ariadocs/mdx/plugins";
PluginWhat it does
remarkGfmTables, task lists and strikethrough
rehypeSlugAdds ids to headings, so TOC links work
rehypeAutolinkHeadingsMakes headings clickable
rehypeCodeTitlesShows the title="file.ts" of a code block above it
rehypePrismSyntax highlighting
rehypeCodeRawLets the Pre component copy the original code

Put rehypeCodeRaw after rehypePrism:

rehypePlugins: [rehypeSlug, rehypeAutolinkHeadings, rehypeCodeTitles, rehypePrism, rehypeCodeRaw];

The color themes for highlighted code are in @ariadocs/components. See syntax themes.