Saltar al contenido principal

Agregar ejemplos de código

Puedes agregar fragmentos de código en línea o bloques de código. Los bloques de código admiten opciones de metadatos para el resaltado de sintaxis, títulos, resaltado de líneas, iconos y más.

Código en línea

Para indicar una palabra o frase como código, enciérrala entre acentos invertidos (`).
Para marcar una `palabra` o `frase` como código, enciérrala entre comillas invertidas (`).

Bloques de código

Usa bloques de código delimitados encerrando el código entre tres comillas invertidas. Los bloques de código se pueden copiar y, si tienes el assistant habilitado, los usuarios pueden pedir a la IA que explique el código. Especifica el lenguaje de programación para el resaltado de sintaxis y para habilitar opciones meta. Agrega cualquier opción meta, como title o icon, después del lenguaje.
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

Opciones del bloque de código

Agrega opciones de metadatos a tus bloques de código para personalizar su apariencia.
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

Activa el resaltado de sintaxis especificando el lenguaje de programación tras las comillas invertidas de apertura de un bloque de código. Usamos Shiki para el resaltado de sintaxis y admitimos todos los lenguajes disponibles. Consulta la lista completa de lenguajes en la documentación de Shiki. Personaliza globalmente los temas de los bloques de código usando 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.
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
Colores de tokens
  • --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
Colores ANSI
  • --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
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

Twoslash

En los bloques de código de JavaScript y TypeScript, usa 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.
type  = "cat" | "dog" | "hamster";

function (: string, : ) {
return `${} the ${} is now adopted!`;
}

// Hover to see the inferred types
const  = ("Mintie", "cat");

Título

Añade un título para etiquetar tu ejemplo de código. Usa title="Your title" o una cadena en una sola línea.
const hello = "world";

Icono

Añade un icono a tu bloque de código usando la propiedad icon. Consulta Iconos para ver todas las opciones disponibles.
const hello = "world";

Resaltado de líneas

Resalta líneas específicas en tus bloques de código usando highlight con los números de línea o los rangos que quieras resaltar.
const greeting = "Hello, World!";
function sayHello() {
  console.log(greeting);
}
sayHello();

Enfoque de líneas

Resalta líneas específicas en tus bloques de código usando focus con números de línea o rangos.
const greeting = "Hello, World!";
function sayHello() {
  console.log(greeting);
}
sayHello();

Mostrar números de línea

Muestra los números de línea en el lado izquierdo de tu bloque de código usando lines.
const greeting = "Hello, World!";
function sayHello() {
  console.log(greeting);
}
sayHello();

Expandible

Permite a los usuarios expandir y contraer bloques de código largos usando expandable.
from datetime import datetime, timedelta
from typing import Dict, List, Optional
from dataclasses import dataclass

@dataclass
class Book:
title: str
author: str
isbn: str
checked_out: bool = False
due_date: Optional[datetime] = None

class Library:
def **init**(self):
self.books: Dict[str, Book] = {}
self.checkouts: Dict[str, List[str]] = {} # patron -> list of ISBNs

    def add_book(self, book: Book) -> None:
        if book.isbn in self.books:
            raise ValueError(f"Book with ISBN {book.isbn} already exists")
        self.books[book.isbn] = book

    def checkout_book(self, isbn: str, patron: str, days: int = 14) -> None:
        if patron not in self.checkouts:
            self.checkouts[patron] = []

        book = self.books.get(isbn)
        if not book:
            raise ValueError("Book not found")

        if book.checked_out:
            raise ValueError("Book is already checked out")

        if len(self.checkouts[patron]) >= 3:
            raise ValueError("Patron has reached checkout limit")

        book.checked_out = True
        book.due_date = datetime.now() + timedelta(days=days)
        self.checkouts[patron].append(isbn)

    def return_book(self, isbn: str) -> float:
        book = self.books.get(isbn)
        if not book or not book.checked_out:
            raise ValueError("Book not found or not checked out")

        late_fee = 0.0
        if datetime.now() > book.due_date:
            days_late = (datetime.now() - book.due_date).days
            late_fee = days_late * 0.50

        book.checked_out = False
        book.due_date = None

        # Remove from patron's checkouts
        for patron, books in self.checkouts.items():
            if isbn in books:
                books.remove(isbn)
                break

        return late_fee

    def search(self, query: str) -> List[Book]:
        query = query.lower()
        return [
            book for book in self.books.values()
            if query in book.title.lower() or query in book.author.lower()
        ]

def main():
library = Library()

    # Añade algunos libros
    books = [
        Book("The Hobbit", "J.R.R. Tolkien", "978-0-261-10295-4"),
        Book("1984", "George Orwell", "978-0-452-28423-4"),
    ]

    for book in books:
        library.add_book(book)

    # Ejemplo de préstamo y devolución
    library.checkout_book("978-0-261-10295-4", "patron123")
    late_fee = library.return_book("978-0-261-10295-4")
    print(f"Late fee: ${late_fee:.2f}")

if **name** == "**main**":
main()

Ajuste

Activa el ajuste de texto para líneas largas con wrap. Esto evita el desplazamiento horizontal y facilita la lectura de líneas extensas.
const greeting = "Hello, World! I am a long line of text that will wrap to the next line.";
function sayHello() {
  console.log(greeting);
}
sayHello();

Diff

Muestra una diferencia visual de las líneas añadidas o eliminadas en tus bloques de código. Las líneas añadidas se resaltan en verde y las eliminadas en rojo. Para crear diferencias, añade estos comentarios especiales al final de las líneas en tu bloque de código:
  • // [!code ++]: Marca una línea como añadida (resaltado en verde).
  • // [!code --]: Marca una línea como eliminada (resaltado en rojo).
Para varias líneas consecutivas, especifica el número de líneas después de dos puntos:
  • // [!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.
La sintaxis del comentario debe coincidir con tu lenguaje de programación (por ejemplo, // para JavaScript o # para Python).
const greeting = "Hello, World!"; 
function sayHello() {
  console.log("Hello, World!"); 
  console.log(greeting); 
}
sayHello();

Componente CodeBlock

Usa el componente <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

language
string
El lenguaje de programación para el resaltado de sintaxis.
filename
string
El nombre del archivo que se mostrará en el encabezado del bloque de código.
icon
string
El icon que se mostrará en el encabezado del bloque de código. Consulta Icons para ver las opciones disponibles.
lines
boolean
Si mostrar números de línea.
wrap
boolean
Si ajustar el bloque de código.
expandable
boolean
Si expandir el bloque de código.
highlight
string
Las líneas que se deben resaltar. Proporciona un arreglo de números en formato de cadena. Ejemplo: "[1,3,4,5]".
focus
string
Las líneas en las que enfocarse. Proporciona un arreglo de números en formato de cadena. Ejemplo: "[1,3,4,5]".

Ejemplo

export const CustomCodeBlock = ({ filename, icon, language, highlight, children }) => {
  return (
    <CodeBlock
      filename={filename}
      icon={icon}
      language={language}
      lines
      highlight={highlight}
    >
      {children}
    </CodeBlock>
  );
};