Agregar ejemplos de código
Código en línea
palabra o frase como código, enciérrala entre acentos invertidos (`).
Bloques de código
Opciones del bloque de código
Debes especificar un lenguaje de programación para un bloque de código antes de agregar cualquier otra opción de metadatos.
Sintaxis de opciones
- Opciones de tipo cadena y booleanas: Envuélvelas con
"",''o sin comillas. - Opciones de expresión: Envuélvelas con
{},""o''.
Resaltado de sintaxis
styling.codeblocks en tu archivo docs.json. Define temas simples como system o dark, o configura temas de Shiki personalizados para los modos claro y oscuro. Consulta Settings para ver las opciones de configuración.
Tema personalizado de resaltado de sintaxis
Tema personalizado de resaltado de sintaxis
Para temas personalizados, establece tu tema en
docs.json como "css-variables" y reemplaza los colores del resaltado de sintaxis usando variables CSS con el prefijo --mint-.Estas variables están disponibles: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 cadena--mint-token-comment: Comentarios--mint-token-keyword: Palabras clave--mint-token-parameter: Parámetros de función--mint-token-function: Nombres de función--mint-token-string-expression: Expresiones de cadena--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
Twoslash
twoslash para habilitar información de tipos interactiva. Los usuarios pueden pasar el cursor sobre variables, funciones y parámetros para ver los 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 los rangos que quieras resaltar.
Enfoque de líneas
focus con números de línea o rangos.
Mostrar números de línea
lines.
Expandible
expandable.
Ajuste
wrap. Esto evita el desplazamiento horizontal y facilita la lectura de líneas extensas.
Diff
// [!code ++]: Marca una línea como añadida (resaltado en verde).// [!code --]: Marca una línea como eliminada (resaltado 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 personalizados de React para renderizar de forma programática bloques de código con el mismo estilo y las mismas funcionalidades que los bloques de código de Markdown.
Props
El lenguaje de programación para el resaltado de sintaxis.
El nombre del 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.
Si mostrar números de línea.
Si ajustar el bloque de código.
Si expandir el bloque de código.
Las líneas que se deben resaltar. Proporciona un arreglo de números en formato de cadena. Ejemplo:
"[1,3,4,5]".Las líneas en las que enfocarse. Proporciona un arreglo de números en formato de cadena. Ejemplo:
"[1,3,4,5]".