Guía de redacción

La documentación de este sitio se escribe en Markdown y admite sintaxis extendida como Frontmatter, bloques de aviso, resaltado de código y fórmulas matemáticas.

Frontmatter

Declara la metainformación de la página en YAML en la parte superior del archivo:

---
title: 页面标题
description: 页面描述（用于 SEO）
tags:
  - 指南
  - Markdown
---

# 正文标题

Campos habituales:

Campo	Descripción
title	Título de la página; sobrescribe el texto mostrado en la navegación
description	Descripción de la página, usada por los buscadores y las tarjetas para compartir
tags	Etiquetas de la página
layout	Diseño de la página; por defecto doc, la página de inicio usa home
outline	Si se muestra el índice de la derecha

Bloques de aviso

:::: tip 提示
这是一条提示信息。
::::

:::: warning 注意
这是一条警告信息。
::::

:::: danger 危险
这是一条危险信息。
::::

:::: info 说明
这是一条普通说明。
::::

Vista previa del resultado:

Consejo

Este es un mensaje de consejo.

Atención

Este es un mensaje de advertencia.

Peligro

Este es un mensaje de peligro.

Información

Esta es una información general.

Bloques de código

Se admite el resaltado de sintaxis para lenguajes habituales como js, ts, bash, python, json, sql, y se pueden mostrar números de línea y resaltar líneas concretas:

```js {2,4-5}
function greet(name) {
  const message = `Hello, ${name}!` // 高亮行
  console.log(message)
  return message
}
```

function greet(name) {
  const message = `Hello, ${name}!` // 高亮行
  console.log(message)
  return message
}

Fórmulas matemáticas

Las fórmulas matemáticas se renderizan con KaTeX:

行内公式 $E = mc^2$

块级公式：

$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$

Tablas

| 方法 | 路径 | 说明 |
| --- | --- | --- |
| GET | `/api/users` | 获取用户列表 |
| POST | `/api/users` | 创建用户 |
| DELETE | `/api/users/:id` | 删除用户 |

Imágenes y enlaces

![替代文本](/logo.svg)

[跳转到快速开始](./getting-started)

Extensiones con componentes

VitePress admite el uso directo de componentes Vue dentro de Markdown, por lo que las interacciones complejas (gráficos, demostraciones, pestañas, etc.) pueden encapsularse como componentes reutilizables.

---

Consejos de redacción

• Cada documento se centra en un tema y usa una jerarquía de títulos clara (# → ## → ###);
• Los ejemplos de código deben poder ejecutarse directamente e incluir los comentarios necesarios;
• Usa bloques de aviso para destacar precauciones y casos límite;
• Enlaza entre documentos relacionados mediante enlaces relativos.