# Formato de código (/es/create/code)
Related: [Registro de cambios](/es/create/changelogs.md), [Archivos](/es/create/files.md), [Imágenes e inserciones](/es/create/image-embeds.md), [Listas y tablas](/es/create/list-table.md), [Contenido personalizado](/es/create/personalization.md), [Redirecciones](/es/create/redirects.md)
## Agregar ejemplos de código [#agregar-ejemplos-de-código]
Puedes agregar fragmentos de código en línea o bloques de código. Los bloques de código ofrecen opciones de metadatos para el resaltado de sintaxis, títulos, resaltado de líneas, iconos y más.
### Código en línea [#código-en-línea]
Para indicar una `palabra` o `frase` como código, enciérrala entre acentos invertidos (\`).
```mdx
Para indicar una `palabra` o `frase` como código, enciérrala entre acentos invertidos (`).
```
### Bloques de código [#bloques-de-código]
Usa [bloques de código delimitados](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) 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 al assistant 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.
HelloWorld.java example
Format
```java icon=java lines
class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
````mdx
```java HelloWorld.java example lines icon="java"
class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
````
## Opciones para bloques de código [#opciones-para-bloques-de-código]
Añade opciones meta 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 añadir cualquier otra opción meta.
### Sintaxis de opciones [#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 [#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.
Mintlify usa [Shiki](https://shiki.style/) para el resaltado de sintaxis y admite todos los lenguajes disponibles. Consulta la lista completa de [lenguajes](https://shiki.style/languages) 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](https://shiki.style/themes) personalizados para los modos claro y oscuro. Consulta [Settings](/es/organize/settings-appearance#styling) para ver las opciones de configuración.
Ejemplo de resaltado de sintaxis
Format
```java
class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
````mdx
```java Ejemplo de resaltado de sintaxis
class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
````
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`
**Resaltado de sintaxis personalizado**
Añade resaltado de sintaxis para lenguajes que no estén incluidos en el conjunto predeterminado de Shiki proporcionando archivos de gramática TextMate personalizados. Crea un archivo JSON siguiendo el [formato de gramática de TextMate](https://macromates.com/manual/en/language_grammars) y luego haz referencia a él en tu `docs.json`. Puedes añadir varios lenguajes personalizados incluyendo rutas adicionales en el array.
```json title="docs.json"
{
"styling": {
"codeblocks": {
"languages": {
"custom": ["/languages/my-custom-language.json"]
}
}
}
}
```
### Twoslash [#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.
twoslash Twoslash example
Format
```ts
type Pet = "cat" | "dog" | "hamster";
function adoptPet(name: string, type: Pet) {
return `${name} the ${type} is now adopted!`;
}
// Hover to see the inferred types
const message = adoptPet("Mintie", "cat");
```
````mdx
```ts twoslash Twoslash example
type Pet = "cat" | "dog" | "hamster";
function adoptPet(name: string, type: Pet) {
return `${name} the ${type} is now adopted!`;
}
// Hover to see the inferred types
const message = adoptPet("Mintie", "cat");
```
````
### Título [#título]
Añade un título para etiquetar tu ejemplo de código. Coloca el título después del identificador de lenguaje. Los títulos pueden contener múltiples palabras y rutas de archivos.
Puedes establecer el título de dos maneras:
* **En línea**: Coloca el título directamente después del identificador de lenguaje.
* **Propiedad `title`**: Usa `title="Your title"` para títulos que necesiten caracteres especiales o comillas explícitas.
Example title
utils/hello.js
Inline format
title property format
```javascript
const hello = "world";
```
```javascript
const hello = "world";
```
````mdx
```javascript Example title
const hello = "world";
```
````
````mdx
```javascript title="utils/hello.js"
const hello = "world";
```
````
### Icono [#icono]
Añade un icono a tu bloque de código usando la propiedad `icon`. Consulta [Iconos](/es/components/icons) para ver todas las opciones disponibles.
Icon example
Formato
```javascript icon=square-js
const hello = "world";
```
````mdx
```javascript Icon example icon="square-js"
const hello = "world";
```
````
### Resaltado de líneas [#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.
Ejemplo de resaltado de líneas
Formato
```javascript {1,2,5}
const greeting = "Hello, World!";
function sayHello() {
console.log(greeting);
}
sayHello();
```
````mdx
```javascript Ejemplo de resaltado de líneas highlight={1-2,5}
const greeting = "Hello, World!";
function sayHello() {
console.log(greeting);
}
sayHello();
```
````
### Enfoque de líneas [#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.
Line focusing example
Format
```javascript focus=2,4,5
const greeting = "Hello, World!";
function sayHello() {
console.log(greeting);
}
sayHello();
```
````mdx
```javascript Line focusing example focus={2,4-5}
const greeting = "Hello, World!";
function sayHello() {
console.log(greeting);
}
sayHello();
```
````
### Mostrar números de línea [#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`.
Ejemplo de mostrar números de línea
Formato
```javascript lines
const greeting = "Hello, World!";
function sayHello() {
console.log(greeting);
}
sayHello();
```
````mdx
```javascript Show line numbers example lines
const greeting = "Hello, World!";
function sayHello() {
console.log(greeting);
}
sayHello();
```
````
### Expandible [#expandible]
Permite a los usuarios expandir y contraer bloques de código largos usando `expandable`.
example
Formato
```python Expandable 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
# Eliminar de los préstamos del cliente
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()
```
````text
```python Expandable example expandable
from datetime import datetime, timedelta
from typing import Dict, List, Optional
from dataclasses import dataclass
# ...
if __name__ == "__main__":
main()
```
````
### Ajuste [#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.
example
Format
```javascript Wrap wrap
const greeting =
"Hello, World! I am a long line of text that will wrap to the next line.";
function sayHello() {
console.log(greeting);
}
sayHello();
```
````mdx
```javascript Wrap example wrap
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 [#diff]
Muestra un diff 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 se resaltan en rojo.
Añade `[!code ++]` o `[!code --]` dentro de un comentario al final de una línea para marcarla como añadida o eliminada. Usa la sintaxis de comentarios de tu lenguaje:
| Lenguaje | Añadidas | Eliminadas |
| ---------------------------------------------- | --------------------- | --------------------- |
| JavaScript, TypeScript, Java, C, C++, Go, Rust | `// [!code ++]` | `// [!code --]` |
| Python, Ruby, Bash, YAML | `# [!code ++]` | `# [!code --]` |
| HTML, XML | `` | `` |
| CSS | `/* [!code ++] */` | `/* [!code --] */` |
| SQL, Lua | `-- [!code ++]` | `-- [!code --]` |
Para varias líneas consecutivas, añade dos puntos y el número de líneas:
* `// [!code ++:3]`: Marca la línea actual y las dos siguientes como añadidas.
* `# [!code --:5]`: Marca la línea actual y las cuatro siguientes como eliminadas.
JavaScript líneas diff
Python líneas diff
JavaScript Format
Python Format
```js
const greeting = "Hello, World!"; // [!code ++]
function sayHello() {
console.log("Hello, World!"); // [!code --]
console.log(greeting); // [!code ++]
}
sayHello();
```
```python
def greet():
print("Hello, World!") # [!code --]
print("Hello, Mintlify!") # [!code ++]
greet()
```
````text
```js JavaScript líneas diff
const greeting = "Hello, World!"; // [!code ++]
function sayHello() {
console.log("Hello, World!"); // [!code --]
console.log(greeting); // [!code ++]
}
sayHello();
```
````
````text
```python Python líneas diff
def greet():
print("Hello, World!") # [!code --]
print("Hello, Mintlify!") # [!code ++]
greet()
```
````
## Componente CodeBlock [#componente-codeblock]
Usa el componente `` en componentes personalizados de React para renderizar bloques de código de forma programática con el mismo estilo y las mismas funciones que los bloques de código de Markdown.
### Props [#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](/es/components/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]"`.
### Ejemplo [#ejemplo]
```jsx
export const CustomCodeBlock = ({
filename,
icon,
language,
highlight,
children,
}) => {
return (
{children}
);
};
```