Como crear un proyecto en easybook

Hace un par de días escribimos sobre easybook, un excelente herramienta a la hora de trabajar con nuestra documentación, libros o papers. La idea de hoy es comenzar a trabajar con easybook, crear un proyecto e ir conociendo su estructura y la forma de implementación.

Una vez que logramos instalar easybook, podemos utilizar su comando ./book new para iniciar un nuevo proyecto. Para obtener más ayuda en todo momento, podemos hacer uso de la opción help:

$ ./book help new

$ ./book new "El codigo k"

A partir de ahora, easybook creó un directorio de trabajo con una estructura muy particular

easybook/
    doc/
        el-codigo-k/
            config.yml
            Contents/
                chapter1.md
                chapter2.md
                images/
            Output/


Es por ello que a medida que vallamos creando proyectos diferentes, todos se van a almacenar en /easybook/doc y su correspondiente directorio. De esa manera es muy práctico tener nuestra documentación ordenada.

Al bueno estilo Symfony2 vamos a encontrar un archivo de configuración raíz que es el más importante config.yml y además nos indica varios parámetros dentro de nuestro libro.

Luego tenemos el directorio Contents/ donde allí vamos a encontrar todos los archivos e imágenes del contenido propio del libro y finalmente el directorio Outputs/ donde vamos a encontrar los diferentes formatos a los que vamos a poder acceder, como por ejemplo PDF, HTML o EPUB.

Cada proyecto que creamos con easybook contiene por defecto datos que podríamos estar exportando a los diferentes formatos, la idea de hoy es comenzar a familiarizarnos con la estructura del proyecto y ver un poco más sobre su archivo de configuración.

Configuración del libro

Tal y como lo mencionamos, config.yml es un archivo de extensión YAML que cuenta con tres secciones diferentes.

La primera es la configuración básica del libro, la segunda es sobre su contenido y finalmente la tercera hace referencia a sus diferentes ediciones, su estructura es similar a este ejemplo:

book:
    # PRIMERA parte: información básica del libro
    title:            "..."
    author:           "..."
    edition:          "..."
    language:         "..."
    publication_date: "..."

    # SEGUNDA parte: contenidos del libro
    contents:
        - ...
        - ...
        - ...

    # TERCERA parte: ediciones del libro
    editions:
        edition1:
            # ...
        edition2:
            # ...
        # …

Haciendo uso del buen estilo YAML, muy simple para leer y muy simple para interpretar. Esta información que aparece en este archivo podemos editarla en todo momento con la información correcta.

Por hoy lo vamos a dejar aquí, en la próxima entrega continuamos avanzando, entrando más en el detalle de los contenidos y más sobre las configuraciones.

Saludos!