Funciones de Markdown
docStatic utiliza Markdown como formato principal para la creación de contenidos. Puedes aprenderlo en diez minutos. Pero no es necesario, ya que el CMS ofrece un entorno completo de edición de texto enriquecido para metadatos, Markdown y componentes de React.
Creación de contenido estructurada y sencilla
Los temas en docStatic constan de tres partes:
- Metadatos (en formato YAML)
- Contenido (en Markdown)
- Componentes React predefinidos.
El CMS garantiza que los metadatos y Markdown se utilicen de forma coherente, mientras que los componentes de React proporcionan un estilo uniforme y compatibilidad con las funciones de reutilización de contenido. No es necesario añadir código JSX por tu cuenta, ya que los componentes ya están disponibles de forma global.
Funciones estándar
Las funciones de Markdown incluyen:
- Estilos de texto en negrita, código, cursiva y tachado.
- Listas con viñetas y numeradas.
- Bloques de código.
- Niveles de encabezado (del 1 al 6).
- Líneas horizontales.
- Imágenes.
- Enlaces.
- Citas.
- Tablas sencillas.
Todas estas opciones se pueden seleccionar directamente desde la barra de herramientas de texto enriquecido del CMS.
A estas, Docusaurus añade:
- Advertencias
- Detalles (contenido desplegable)
- Listas de fichas de documentación
- Pestañas
docStatic amplía aún más estas posibilidades con:
- Fragmentos de código (desde archivos)
- Comentarios
- Texto condicional
- Enlaces de ayuda contextual
- Diagramas
- Figuras
- Notas al pie
- Términos del glosario
- Ecuaciones matemáticas
- Temas relacionados (generados automáticamente)
- Fragmentos
- Variables
Front matter
La información preliminar se utiliza para añadir metadatos a tu archivo Markdown. Se incluye en la parte superior del archivo, entre tres guiones ---. Los complementos de contenido pueden tener su propio esquema de información preliminar. docStatic utiliza la información preliminar para:
- Condiciones (para texto condicional)
- Descripciones
- Slugs (rutas fijas)
- Etiquetas de taxonomía
- Títulos
- Estado del flujo de trabajo
Detalles
- Selecciona Detalles en la lista Incrustar.
- Edita el componente.
- Añádele un Resumen.
- Introduce los Detalles.
Ejemplo:
Mostrar/ocultar.
Este es el contenido detallado.
Aquí puedes usar Markdown, incluido texto en negrita y cursiva, y enlaces en línea.
Listas de fichas de documentación
Las listas de fichas de documentación se generan automáticamente para las categorías de la tabla de contenidos. Sin embargo, también puedes añadirlas manualmente a un tema.
- Selecciona Lista de fichas de documentación en la lista Incrustar.
- Asigna un Título.
Para obtener más información, consulta Funciones de Markdown en la documentación de Docusaurus.
Ejemplo:
Admonitions
El componente Advertencias te permite añadir advertencias con estilo.
Assets
A veces es posible que desee vincular activos (por ejemplo, archivos docx, imágenes, etc.) directamente desde los temas. docStatic gestiona esto a través de la carpeta static/.
CALS Tables
Using CALS tables in docStatic, including merged cells, column widths and border control.
Citations
1 artículo
Code blocks and snippets
docStatic ofrece dos formas de incluir código en tu documentación. Ambas admiten el resaltado de sintaxis.
Comments
El componente Comentario te permite añadir comentarios que son visibles en el CMS, pero no en la página final, ni siquiera en el código fuente sin procesar.
Conditional text
El componente Texto condicional te permite incluir contenido dentro de un conjunto de condiciones que determinan cuándo debe mostrarse:
Context-sensitive help
«La ayuda contextual es un tipo de
Diagramas
Crear diagramas con Mermaid.
Figuras
Imágenes con leyendas y zoom en lightbox.
Notas al pie
Notas al pie numeradas automáticamente y con enlace de retorno.
Glossary terms
El componente Término del glosario te permite introducir una clave que se asocia a un término localizado y a una descripción. El término aparece subrayado. Al pasar el cursor por encima del término, aparece el cursor de ayuda, y al mantenerlo sobre él se muestra la descripción en forma de información sobre herramientas. En dispositivos con pantalla táctil, al pulsar sobre el término se muestra una ventana emergente con la definición.
Head metadata
docStatic configura automáticamente metadatos útiles para la página en `, y `.
Headings and table of contents
En el CMS, puede seleccionar el nivel Párrafo o Encabezado (del 1 al 6).
Markdown links
Hay dos formas de añadir un enlace a otra página: mediante una ruta URL o una ruta de archivo.
Math equations
Las ecuaciones matemáticas se pueden representar utilizando .
MDX and React
docStatic incluye soporte integrado para MDX, lo que te permite escribir JSX dentro de tus archivos Markdown y renderizarlos como componentes de React. Sin embargo, si añades JSX directamente en tus temas, el CMS no podrá mostrarlos en el editor de texto enriquecido.
MDX plugins
MDX tiene un sistema de complementos integrado que se puede utilizar para personalizar la forma en que se analizan y transforman los archivos Markdown a JSX. Sin embargo, si cambia el comportamiento de Markdown, también debe reflejar estos cambios en el CMS.
Related Topics
El componente Temas relacionados sugiere automáticamente contenido relacionado basado en etiquetas de taxonomía compartidas. Analiza las etiquetas de la página actual y encuentra otros documentos con etiquetas similares, luego los muestra como una lista seleccionada de recomendaciones.
Snippets
El componente Fragmento te permite reutilizar contenido en toda tu documentación. Un fragmento es un fragmento de contenido que se puede insertar en uno o varios temas. Cuando realizas cambios en el fragmento, estos se aplican en todos los lugares donde se utilice dicho fragmento. Esto puede resultar especialmente útil para el texto repetitivo. Los fragmentos tienen su propia colección en el CMS y se encuentran en una sección independiente del repositorio.
Tabs
El componente Pestañas te permite añadir contenido con pestañas a tu tema.
Variable sets
El componente Variable le permite colocar una variable localizada en su texto.