El archivo de configuración de proyecto

Hemos iniciado el proyecto con el comando

mdbook init

y esto ha creado una estructura inicial de subcarpetas y archivos. En el directorio raíz hay un fichero especial llamado book.toml.

Sintaxis

El archivo de configuración contiene los parámetros del proyecto. Examinémoslo con el editor de textos:

[book]

title = "Mi primer libro"
authors = ["Pedro" , "Ana"]
language = "en"

Cada pareja clave = valor es un parámetro de configuración. Estos archivos siguen la sintaxis TOML. Véase Wikipedia.

En resumen, el contenido de un archivo de configuración puede tener:

parejas clave=valor
todas ellas agrupadas en secciones, encabezadas por un nombre de sección entre corchetes
podemos insertar líneas en blanco para facilitar la lectura del fichero
las líneas que empiezan por un carácter # se consideran como “comentarios” y serán ignoradas.

Los valores pueden ser:

textos. Por ejemplo, el título del libro:
```
title = "Mi primer libro"
```
valores numéricos. No llevan comillas. Por ejemplo, el límite máximo de resultados en las búsquedas:
```
limit-results = 20
```
valores true/false (verdadero/falso). Por ejemplo, activar la creación automática de ficheros que no existen, pero se los menciona en el archivo SUMMARY.md. Esta anomalía se detecta en el proceso de generación del libro, tanto en modo build como serve.
```
create-missing = true 
```
listas de valores, entre corchetes y con los elementos separados por comas:
```
authors = ["Pedro" , "Ana"]
```

Personalización

Vamos a cambiar algunos valores:

[book]
title = "Mi primer libro"
authors = ["Pedro" , "Ana"]
language = "es"
description = "Mi primer libro"
src = "src"

[build]
create-missing = false
build-dir = "book"  

[output.html]
default-theme = "rust"
preferred-dark-theme = "navy"

Hemos cambiado:

el idioma, “es” en lugar de “en”. Esto no traduce elementos generados por mdBook, pero en el HTML final, en la sección <head> de cada página, se incluye esa información.
el parámetro description también se añade como información añadida en la sección <head> del HTNL generado. La usan los buscadores web.
he desactivado la creación automática de ficheros faltantes cuando están incluidos en SUMMARY.md. No me gusta que el programa actúe a mis espaldas e inadvertidamente cree ficheros por error.
el tema por defecto. Si no hacemos nada suele ser light
el tema a aplicar por defecto cuando el sistema operativo está configurado en dark.
el directorio de salida para los resultados de la conversión a HTML. Aquí no es necesario, porque lo especificamos en el comando build o serve
el directorio donde se encuentran los archivos fuente. No es necesario, porque es “src” por defecto. Pero podemos cambiarlo.

Teclas de atajo

Tutorial de mdBook

El archivo de configuración de proyecto

Sintaxis

Personalización