Referencia de la CLI
plasmoid tiene dos verbos: build y serve.
plasmoid build
Renderiza un árbol de documentación en un sitio estático completo.
| Opción | Por defecto | Descripción |
|---|---|---|
--docs <DIR> | ./docs | Directorio de documentación (debe contener plasmoid.toml). |
--site <DIR> | — | Directorio de salida para el sitio construido. |
--version <V> | desde Cargo.toml | Sobrescribe la versión resuelta. Obligatorio cuando [versions] source = "manual". |
--palette <NAME> | desde [theme] palette | Tono a emitir, anulando la configuración. Se resuelve desde docs/themes/<name>.css, luego --themes-dir/[theme] themes_dir, y por último el default incluido. |
--themes-dir <DIR> | desde [theme] themes_dir | Biblioteca de temas externa (contiene tokens.base.css + themes/<tone>.css), anulando la configuración. Una ruta relativa se resuelve respecto al directorio actual. |
La construcción es determinista y sin conexión: las mismas entradas producen una salida idéntica byte a byte, sin red. Consulta La cadena de construcción.
plasmoid serve
Construye el sitio y lo sirve localmente para previsualizarlo, reconstruyéndolo opcionalmente ante cada cambio.
| Opción | Por defecto | Descripción |
|---|---|---|
--docs <DIR> | ./docs | Directorio de documentación que se construye y sirve. |
--port <N> | 8080 | Puerto del servidor de previsualización local. |
--watch | desactivado | Reconstruye y recarga en vivo ante cambios de archivos. |
--palette <NOMBRE> | de [theme] palette | Tono a previsualizar, anulando la configuración (igual que build --palette). |
--themes-dir <DIR> | de [theme] themes_dir | Biblioteca de temas externa desde la que previsualizar, anulando la configuración (igual que build --themes-dir). |
--palette y --themes-dir facilitan previsualizar otro tono localmente sin editar
la configuración — y --palette por sí solo basta cuando [theme] themes_dir ya está
definido, ya que solo cambia el tono que se resuelve desde esa biblioteca.
serve construye en un directorio temporal de previsualización y lo sirve mediante
un pequeño servidor HTTP integrado. Con --watch, las ediciones disparan una
reconstrucción y los navegadores conectados se recargan automáticamente.
Estado de salida
Ambos verbos terminan con un código distinto de cero y un mensaje accionable ante un error: un campo de configuración incorrecto, un archivo ilegible o una versión que no se puede resolver. Los mensajes de error nombran el archivo o campo problemático para que puedas corregirlo directamente.
Ejemplos
# One-off production build
# Build a non-Rust project at an explicit version
# Live-editing preview on a custom port