Referencia de configuración

El sitio se configura mediante un único plasmoid.toml en la raíz de la documentación. Cada campo tiene un valor por defecto razonable, así que una configuración mínima es solo un título:

[site]
title = "My Project"

Las claves desconocidas se rechazan, de modo que una errata se detecta en tiempo de construcción en lugar de ignorarse silenciosamente.

`[site]`

[site]
title = "My Project"            # required
default_locale = "en"           # default: "en"
locales = ["en", "es"]          # default: ["en"]; must contain default_locale
repo_url = "https://gitlab.com/you/project"   # optional, enables the chrome "Source" link
logo = "brand/logo.svg"         # optional, path relative to the docs root

Clave	Por defecto	Notas
`title`	—	Obligatorio, no vacío. Se muestra en el marco de la interfaz.
`default_locale`	`"en"`	Define la estructura del sitio y el locale de reserva.
`locales`	`["en"]`	Todos los locales publicados. Debe incluir `default_locale`.
`repo_url`	ninguno	URL opcional del repositorio. Habilita el enlace “Source” del marco. Déjalo sin definir para omitirlo.
`logo`	ninguno	Imagen (relativa a la raíz de la documentación) que se muestra en el marco.

`[versions]`

[versions]
source = "cargo"   # "cargo" | "manual"; default "cargo"
retain = 5         # newest N kept live; default 5, must be ≥ 1

source = "cargo" lee package.version del Cargo.toml situado por encima del directorio de documentación. source = "manual" requiere --version en cada construcción.
retain controla cuántas versiones se mantienen en línea antes de que las más antiguas se archiven en zip. Consulta Versionado.

`[landing]`

[landing]
dir = "landing"    # optional: a prebuilt static landing to mount at /

Si dir apunta a un directorio, plasmoid lo copia a / tal cual. De lo contrario se usa la página de inicio en Markdown (o una redirección); consulta Resumen del despliegue. Siempre que una página de inicio real ocupe /, los enlaces de marca/logo del marco de la documentación vuelven a ella automáticamente; haz que el enlace “Read the docs” de la página de inicio apunte al alias estable /docs/ para cerrar el ciclo.

`[theme]`

[theme]
palette = "default"                   # tono a emitir — por defecto
themes_dir = "../brand"               # biblioteca de temas externa (opcional)
font_body = "Atkinson Hyperlegible"   # default (bundled, OFL)
font_mono = "JetBrains Mono"          # default
fonts = "self-hosted"                 # "self-hosted" (default) | "system"

Clave	Por defecto	Notas
`palette`	`"default"`	Tono a emitir; el `/assets/tokens.css` emitido es la capa base compartida + este tono. El binario incluye únicamente el `"default"` neutro; cualquier otro nombre se resuelve desde `docs/themes/<nombre>.css` o `themes_dir`. Lo anula `--palette`. Ver Temas.
`themes_dir`	(sin definir)	Directorio de biblioteca de temas externa que contiene `tokens.base.css` + `themes/<tono>.css` (misma disposición que `docs/`). Permite que un proyecto use tonos con nombre sin empaquetarlos en el binario. Una ruta relativa se resuelve respecto al directorio de documentación. Lo anula `--themes-dir`.
`font_body`	`"Atkinson Hyperlegible"`	Familia del cuerpo de texto. El valor por defecto incluido se autoaloja automáticamente.
`font_mono`	`"JetBrains Mono"`	Familia monoespaciada (reserva del sistema salvo que proporciones un woff2 `mono*`).
`fonts`	`"self-hosted"`	`"self-hosted"` emite `@font-face` (el valor por defecto incluido o `docs/fonts/*.woff2`); `"system"` usa solo la pila de fuentes del sistema.

Consulta Temas para autoalojar tu propio woff2.

`[deploy]`

[deploy]
aliases = "symlink"   # "symlink" (default) | "copy" | "redirect"

Cómo se materializan los alias estables /docs/ y /latest/.

Ejemplo completo

[site]
title = "plasmoid"
default_locale = "en"
locales = ["en"]
repo_url = "https://gitlab.com/rglw/plasmoid"   # powers the "Source" link

[versions]
source = "cargo"
retain = 5

[landing]

[theme]
palette = "default"
font_body = "Atkinson Hyperlegible"
font_mono = "JetBrains Mono"
fonts = "self-hosted"

[deploy]
aliases = "symlink"