Skip to content
StudioCMS Docs
Main Site

@studiocms/mdx

v0.1.0-beta.30 GitHub npm Changelog

Introduction

Section titled “Introduction”

This plugin enables MDX Support within StudioCMS.

Installation

Section titled “Installation”

  1. Install the package using the following command:

    Terminal window
    npm run studiocms add @studiocms/mdx

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

    studiocms.config.mjs
    import { 
    function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
    A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.
    

    StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.
    

    Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
    @example 
    // studiocms.config.mjs
    import { defineStudioCMSConfig } from 'studiocms/config';
    

    export default defineStudioCMSConfig({
     dbStartPage: true,
     // ...Other Options
    })
    defineStudioCMSConfig     } from 'studiocms/config';
    import 
    function mdx(options?: MDXPluginOptions): StudioCMSPlugin
    Creates and configures the StudioCMS MDX plugin.
    @param ― options - Optional configuration options for the MDX plugin.
    @returns ― The configured StudioCMS plugin.
    @example 
    plugins: [
      studiocmsMDX({
        remarkPlugins: [],
        rehypePlugins: [],
        recmaPlugins: [],
        remarkRehypeOptions: {}
      }),
    ]
    mdx     from '@studiocms/mdx';
    

     export default 
    function defineStudioCMSConfig(config: StudioCMSOptions): StudioCMSOptions
    A utility function to define the StudioCMS config object.
This function is used to define the optional StudioCMS
config object in the Astro project root. The expected file
name is studiocms.config.mjs. And it should be adjacent
to the Astro project's astro.config.mjs file.
    

    StudioCMS will attempt to import this file and use the default
export as the StudioCMS config object automatically if it exists.
    

    Using this function is optional, but it can be useful for IDEs
to provide better intellisense and type checking.
    @example 
    // studiocms.config.mjs
    import { defineStudioCMSConfig } from 'studiocms/config';
    

    export default defineStudioCMSConfig({
     dbStartPage: true,
     // ...Other Options
    })
    defineStudioCMSConfig    ({
       
    StudioCMSOptions.plugins?: StudioCMSPlugin[]
    Add Plugins to the StudioCMS
    plugins    : [
         
    function mdx(options?: MDXPluginOptions): StudioCMSPlugin
    Creates and configures the StudioCMS MDX plugin.
    @param ― options - Optional configuration options for the MDX plugin.
    @returns ― The configured StudioCMS plugin.
    @example 
    plugins: [
      studiocmsMDX({
        remarkPlugins: [],
        rehypePlugins: [],
        recmaPlugins: [],
        remarkRehypeOptions: {}
      }),
    ]
    mdx    (),
       ],
     });