Saltearse al contenido
StudioCMS Docs
Sitio Principal

@studiocms/markdoc

v0.2.0 GitHub npm Registro de cambios

Introducción

Sección titulada «Introducción»

Este complemento habilita el soporte de MarkDoc dentro de StudioCMS.

Instalación

Sección titulada «Instalación»

  1. Instala el paquete usando el siguiente comando:

    Ventana de terminal
    npm run studiocms add @studiocms/markdoc

  2. La configuración de StudioCMS debería incluir @studiocms/markdoc:

    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 markdoc(options?: MarkDocPluginOptions): StudioCMSPlugin
    markdoc     from '@studiocms/markdoc';
    

     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 markdoc(options?: MarkDocPluginOptions): StudioCMSPlugin
    markdoc    (),
       ],
     });