@studiocms/md

Introduction

This plugin enables MD Support within StudioCMS.

Installation

1. Install the package using the following command:

   npm

   npm run studiocms add @studiocms/md

   pnpm

   pnpm run studiocms add @studiocms/md

   yarn

   yarn run studiocms add @studiocms/md

2. Your StudioCMS config should now include @studiocms/md:

   studiocms.config.mjs

   import { defineStudioCMSConfig } from 'studiocms/config';
   import md from '@studiocms/md';
   
    export default defineStudioCMSConfig({
      plugins: [
        md(),
      ],
    });

Options

studiocms Flavored Markdown

type StudioCMSMarkdown = {
  flavor: "studiocms";
  autoLinkHeadings: boolean;
  callouts: false | "github" | "obsidian" | "vitepress";
  discordSubtext: boolean;
  sanitize: {
    allowAttributes: Record<string, string[]>;
    allowComments: boolean;
    allowComponents: boolean;
    allowCustomElements: boolean;
    allowElements: string[];
    blockElements: string[];
    dropAttributes: Record<string, string[]>;
    dropElements: string[];
  };
};

astro Flavored Markdown

type AstroMarkdown = {
  flavor: "astro";
  sanitize: {
    allowAttributes: Record<string, string[]>;
    allowComments: boolean;
    allowComponents: boolean;
    allowCustomElements: boolean;
    allowElements: string[];
    blockElements: string[];
    dropAttributes: Record<string, string[]>;
    dropElements: string[];
  };
};