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:

---
type: page
title: Getting Started
listed: true
slug: getting-started
description:
index_title: Getting Started
hidden: false
keywords: keyword1,keyword2
tags: tag1,tag2
---

Sintaxis de Markdoc

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

## Headers

**Bold**

_Italic_

[Links](/docs/nodes)

![Images](/logo.svg)

Unordered Lists
- Item 1
- Item 2
- Item 3

Ordered Lists
1. Item 1
2. Item 2
1. Item 1 under 2
3. Item 3

> Callouts

`Inline code`

```
Code fences
```

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

Los bloques tienen la siguiente sintaxis:

{% block-type attr1="value1" attr2="value" %}
contents
{% /block-type %}

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

{% icon classes="fas fa-bookmark" /%}
{% glossary term="CDN" /%}

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 %}.

```javascript {% title="fibonacci.js" %}
function fibonacci(num, memo) {
memo = memo || {};

if (memo[num]) return memo[num];
if (num <= 1) return 1;

return memo[num] = fibonacci(num - 1, memo) + fibonacci(num - 2, memo);
}
```

Imágenes

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

{% image url="https://uploads.developerhub.io/dev/V5Na/u0dpegq8xdpnclhctkpxycekhj04sev9j2kztstph3bnj41cde13o7vuzlpxw6yj.jpg" width=464 %}
Image caption
{% /image %}

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.

{% table layout="auto" %}
{% row %}
{% cell header=true %}
Parameter
{% /cell %}
{% cell header=true %}
Type
{% /cell %}
{% /row %}
{% row %}
{% cell %}
user_id
{% /cell %}
{% cell %}
int
{% /cell %}
{% /row %}
{% /table %}

Llamadas de atención

{% callout type="success" title="Success" %}
Great **success**!
{% /callout %}

Vídeos

{% video provider="loom" videoId="e5b8c04bca094dd8a5507925ab887002" /%}

Bloques sincronizados

{% synced id="open-block-menu" /%}

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:

{% synced id="install-steps" variables={"tool":"Acme Cloud","version":"3.0"} /%}

El archivo del propio bloque declara las variables y las usa, como se muestra en Bloques sincronizados.

HTML personalizado

{% html %}
SWISHHTMLBODY0
{% /html %}

Pestañas

{% tabs %}
{% tab title="Android" %}
Android content.
{% /tab %}
{% tab title="iOS" %}
iOS content.
{% /tab %}
{% /tabs %}

Registro de cambios

{% changelog label="31 July 2024" slug="31-july-2024" date="2024-07-31" %}
- {% badge type="warning" text="Change" /%} **API References**: Writers can [create and edit](/support-center/collaboration) API references in draft now.
{% /changelog %}

Código de GitHub

{% github-code url="https://github.com/torvalds/linux/blob/master/kernel/signal.c#L152-L170" /%}

Lista de índice

{% index-list /%}


  Última actualización