Formato Markdoc

El formato Markdoc es el formato que se utiliza cuando las páginas se sincronizan en DeveloperHub mediante GitHub Sync. Markdoc es un framework de creación basado en markdown para escribir documentación.

Si creas páginas con un agente de programación con IA, nuestra Markdoc Agent Skill le enseña esta sintaxis exacta, de modo que sus ediciones se conserven sin pérdidas en el ciclo de ida y vuelta.

Sintaxis de frontmatter

Cada página tiene un encabezado de frontmatter, como este:

Sintaxis de Markdoc

Markdoc es un superconjunto de Markdown, por lo que puedes seguir escribiendo Markdown como de costumbre, incluidos los siguientes nodos:

Además de Markdown, ofrecemos etiquetas y atributos para todos los bloques y bloques en línea.

Los bloques tienen la siguiente sintaxis:

Mientras que los bloques en línea tienen la siguiente sintaxis:

A continuación se muestra la sintaxis de cada bloque con un ejemplo:

Bloque de código

Un bloque de código es un único bloque delimitado con el lenguaje indicado en la valla de apertura. Las pestañas de código agrupan varios bloques delimitados dentro de un par {% code %} / {% /code %}.

Imágenes

Se cierra a sí misma cuando no hay pie de imagen, o usa una forma con cuerpo cuando lo hay:

Tablas

Las tablas son árboles de {% row %} y {% cell %}; una celda de encabezado establece header=true. Añade stickyHeader=true para fijar la fila de encabezado mientras la tabla se desplaza. Una tabla simple también se puede escribir como una tabla Markdown normal con barras verticales.

Llamadas de atención

Vídeos

Bloques sincronizados

HTML personalizado

Pestañas

Registro de cambios

Código de GitHub

Lista de índice