Saltar al contenido
CXGdocs.GUÍAS
Volver a la tienda
Primeros pasosCómo documentar
CXG DOCUMENTATION

Cómo documentar

Escribe en Markdown. La web se encarga del resto.

Crea una página

Añade un archivo .md dentro de content/documentation/. Usa una carpeta por script y subcarpetas para sus secciones. El primer título de nivel uno será el nombre de la página.

Ordena el contenido

Los archivos se ordenan por nombre. Puedes usar prefijos como 01- y 02- para controlar el orden; los números de las carpetas se ocultan en el menú.

Markdown compatible

Puedes escribir negrita, cursiva, listas, enlaces, citas, imágenes, tablas y bloques de código. Los títulos de nivel dos y tres aparecen en el índice lateral.

  • Carpetas y subcarpetas
  • Enlaces relativos entre archivos
  • Tablas y listas de tareas

El HTML incrustado y los componentes MDX no se ejecutan. Esta preview utiliza Markdown estándar con extensiones de GitHub.

Enlaza otra guía

Utiliza la ruta relativa al archivo actual, por ejemplo: [Instalación](../02-advanced-police-job/01-instalacion.md).

Los archivos nuevos aparecen al recargar la página en desarrollo. La publicación final requerirá desplegar los cambios del repositorio.

CXG · DocumentaciónUna buena base. Infinitas posibilidades.