Componentes

Es una página de prueba, y está de última a propósito. Cada sección de abajo usa un bloque distinto, con los estados que ese bloque puede tomar, para poder mirarlos todos juntos —en claro y en oscuro, en una pantalla y en un teléfono— sin navegar entre ocho guías.

Cuando la documentación se abra al público, esta página se borra.

Texto

Un párrafo normal, para tener contra qué comparar todo lo demás. Lleva código en línea, un enlace interno, un enlace externo, negrita y cursiva. La medida está limitada, así que este párrafo debería cortar bastante antes del borde derecho de la columna aunque la ventana sea ancha.

Una cita. Sirve para separar algo dicho por otro —una resolución, un artículo— del texto que lo explica.

• Un ítem
• Otro ítem
  • Uno anidado
• Un tercero

1. Primero
2. Segundo
3. Tercero

Avisos

Cuatro tonos, y cada uno significa algo distinto. El tono es una decisión sobre consecuencia, no sobre decoración.

Pasos

1. Cotizá

   Preguntá cuánto impuesto lleva la venta. No crea nada y no consume consecutivos.

2. Emití

   Mandá el documento con Idempotency-Key. Si repetís la petición con la misma llave, recibís el documento que ya existe.

3. Esperá el veredicto

   Seguí el estado o, mejor, registrá un webhook y dejá que Timbre te avise.

Tarjetas

Campos

Tabla

Archivos

Preguntas

Código

Un bloque suelto lleva su lenguaje arriba y el botón de copiar al pasar el mouse:

{
  "clave": "50601012600310112345600100001010000000001199999999",
  "estado": "accepted",
  "consecutivo": "00100001010000000001"
}

Uno largo, para comprobar que desborda hacia adentro y no empuja la página:

echo "esta línea es deliberadamente larguísima para comprobar que el bloque de código scrollea dentro de su propio marco y no hace que la página entera se mueva de lado"

Y el de los ejemplos de la API. La franja no dice el lenguaje —«cURL» encima de un comando que empieza con curl no informa de nada— sino qué es el bloque, que es lo que hay que averiguar cuando una página alterna los dos:

curl https://api.timbre.cr/internal/v1/issuers \
  -H "Authorization: Bearer timbre_sk_…"

Con nombre de archivo

Cuando el bloque es un archivo, el nombre importa más que el lenguaje y ocupa su lugar:

export const timbre = createClient({
  apiKey: process.env.TIMBRE_API_KEY,
})

Anotaciones

Las marcas van en un comentario del propio código, así que el ejemplo sigue siendo válido si alguien lo copia: el comentario desaparece al renderizar.

const quote = await timbre.quotes.create({
  issuerId, 
  lines,
})

const invoice = await timbre.invoices.create({
  issuerId,
  finalize: true,
})

El :4 cuenta las líneas siguientes, así que la marca vive en su propia línea y ninguna herramienta que reformatee el archivo puede moverla a la línea equivocada.

Un diff, para explicar un cambio en lugar de mostrar dos bloques enteros:

const response = await fetch(url, {
  headers: {
    Authorization: `Bearer ${key}`, 
    Authorization: `Bearer ${process.env.TIMBRE_API_KEY}`, 
  },
})

Y una palabra suelta, cuando lo que importa es un identificador y no la línea:

{ "estado": "permanent_error" } 

Sin copiar

Una respuesta de ejemplo no es algo que nadie deba pegar en ningún lado, así que no ofrece el botón:

timbre_sk_ejemplo_no_es_una_llave_real

Encabezados

Un encabezado de nivel tres

Para ver la sangría en el índice de la derecha y comprobar que el ancla queda debajo de la barra pegajosa y no tapada por ella.

Un encabezado de nivel cuatro

El más profundo que las guías usan.