Añadir ejemplos de código
Código en línea
palabra o frase es código, enciérrala entre comillas invertidas (`).
Bloques de código
Opciones de bloques de código
Debes especificar un lenguaje de programación para un bloque de código antes de añadir cualquier otra opción de metadatos.
Sintaxis de opciones
- Opciones de tipo cadena (string) y booleanas: Escríbelas entre
"",''o sin comillas. - Opciones de expresión: Escríbelas entre
{},""o''.
Resaltado de sintaxis
styling.codeblocks en tu archivo docs.json. Establece temas simples como system o dark, o configura temas de Shiki personalizados para los modos claro y oscuro. Consulta Configuración para ver las opciones de configuración.
Tema de resaltado de sintaxis personalizado
Tema de resaltado de sintaxis personalizado
Para temas personalizados, configura el tema en
docs.json como "css-variables" y redefine los colores de resaltado de sintaxis usando variables de CSS con el prefijo --mint-.Están disponibles las siguientes variables:Colores básicos--mint-color-text: Color de texto predeterminado--mint-color-background: Color de fondo
--mint-token-constant: Constantes y literales--mint-token-string: Valores de tipo string--mint-token-comment: Comentarios--mint-token-keyword: Palabras clave--mint-token-parameter: Parámetros de funciones--mint-token-function: Nombres de funciones--mint-token-string-expression: Expresiones de tipo string--mint-token-punctuation: Signos de puntuación--mint-token-link: Enlaces
--mint-ansi-black,--mint-ansi-black-dim--mint-ansi-red,--mint-ansi-red-dim--mint-ansi-green,--mint-ansi-green-dim--mint-ansi-yellow,--mint-ansi-yellow-dim--mint-ansi-blue,--mint-ansi-blue-dim--mint-ansi-magenta,--mint-ansi-magenta-dim--mint-ansi-cyan,--mint-ansi-cyan-dim--mint-ansi-white,--mint-ansi-white-dim--mint-ansi-bright-black,--mint-ansi-bright-black-dim--mint-ansi-bright-red,--mint-ansi-bright-red-dim--mint-ansi-bright-green,--mint-ansi-bright-green-dim--mint-ansi-bright-yellow,--mint-ansi-bright-yellow-dim--mint-ansi-bright-blue,--mint-ansi-bright-blue-dim--mint-ansi-bright-magenta,--mint-ansi-bright-magenta-dim--mint-ansi-bright-cyan,--mint-ansi-bright-cyan-dim--mint-ansi-bright-white,--mint-ansi-bright-white-dim
docs.json. Puedes agregar varios lenguajes personalizados incluyendo rutas adicionales en el array.docs.json
Twoslash
twoslash para habilitar información interactiva sobre tipos. Los usuarios pueden colocar el cursor sobre variables, funciones y parámetros para ver tipos y errores como en un IDE.
Título
title="Your title" o una cadena en una sola línea.
Icono
icon. Consulta Iconos para ver todas las opciones disponibles.
Resaltado de líneas
highlight con los números de línea o rangos que deseas resaltar.
Enfoque de líneas
focus con números o rangos de líneas.
Mostrar números de línea
lines.
Expandible
expandable.
Ajuste de línea
wrap. Esto evita el desplazamiento horizontal y hace que las líneas largas sean más fáciles de leer.
Diff
// [!code ++]: Marca una línea como añadida (resaltada en verde).// [!code --]: Marca una línea como eliminada (resaltada en rojo).
// [!code ++:3]: Marca la línea actual más las dos siguientes como añadidas.// [!code --:5]: Marca la línea actual más las cuatro siguientes como eliminadas.
// para JavaScript o # para Python).
Componente CodeBlock
<CodeBlock> en componentes React personalizados para renderizar de manera programática bloques de código con el mismo estilo y las mismas características que los bloques de código de Markdown.
Props
El lenguaje de programación para el resaltado de sintaxis.
El nombre de archivo que se mostrará en el encabezado del bloque de código.
El icon que se mostrará en el encabezado del bloque de código. Consulta Icons
para ver las opciones disponibles.
Indica si se deben mostrar los números de línea.
Indica si se debe ajustar el bloque de código.
Indica si el bloque de código se puede expandir.
Las líneas que se deben resaltar. Proporciona un array de números como cadena. Ejemplo:
"[1,3,4,5]".Las líneas en las que se debe centrar la atención. Proporciona un array de números como cadena. Ejemplo:
"[1,3,4,5]".