Formato Markdoc
El formato Markdoc es el formato que se utiliza cuando las páginas se sincronizan en DeveloperHub mediante Sincronización con GitHub. Markdoc es un marco de creación basado en Markdown para escribir documentación.
Si creas páginas con un agente de programación con IA, nuestro Markdoc Agent Skill le enseña esta sintaxis exacta, de modo que sus ediciones se convierten de ida y vuelta sin problemas. Para ver una página tal como la verán los lectores mientras la escribes, usa la vista previa del editor.
Sintaxis del 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 en la valla de apertura. Las pestañas de código agrupan varios bloques delimitados en 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, y searchable=true a una celda de encabezado para que los lectores puedan buscar en esa columna. Una tabla sencilla también se puede escribir como una tabla Markdown simple con barras verticales.
Llamadas de atención
Vídeos
Bloques sincronizados
Si el bloque tiene variables, una página puede establecer sus propios valores para ellas con variables, cada uno entre comillas. Cualquier variable omitida muestra el valor predeterminado del bloque:
El archivo del propio bloque declara las variables y las usa, como se muestra en Bloques sincronizados.
HTML personalizado
Pestañas
Registro de cambios
Código de GitHub
Lista de índice
Need help? Visit our community forums or contact us.