Gitbook es una herramienta para documentar proyectos de manera fácil, usando solamente archivos .md
, ofrece la posibilida de configurar y customizar los Themas, la igual que permite levantar un servidor local para edición.
Entrar en la carpeta docker-node-gitbook
, para generar la imagen Docker localmente
docker build -t docker-node-gitbook .
Es necesario estar posicionado en el directorio del proyecto al cual le queremos agregar documentación con Gitbook. El siguiente comando, creará el directorio docs que contendrá el Gitbook.
La referencia
${PWD##*/}
identifica el directorio actual desde el cual se está ejecutando el comandogitbook init
que genera los archivos necesarios para iniciar a trabajar con el proyecto Gitbook.
docker run -it --rm \
-v $(pwd):/docker-node-gitbook \
--name ${PWD##*/} docker-node-gitbook:latest \
gitbook init docs
Configuración de dependecias: Con el comando anterior se creó la carpeta
docs
con el libro, para instalar las dependecias tenemos que crear el archivobook.json
en la carpeta docs con el siguiente contenido:
{
"title": "GitBook",
"description": "Test Book GitBook",
"author": "3rm",
"plugins": [
"lunr",
"fontsettings",
"highlight",
"livereload",
"-sharing",
"back-to-top-button",
"search"
],
"theme-default": {
"showLevel": true
}
}
Instalar depedencias: Todos las dependencias configuradas en el archivo
book.json
, se instalan de la siguiente manera.
docker run -it --rm \
-v $(pwd):/docker-node-gitbook \
--name ${PWD##*/} docker-node-gitbook:latest \
gitbook install docs
Siempre se debe estar parado sobre el directorio que contiene libro el directorio padre de la carpeta **docs**
para poder levantar el servidor local de Gitbook con gitbook serve docs
.
docker run -it --rm \
-p 7000:4000 \
-v $(pwd):/docker-node-gitbook \
--name ${PWD##*/} docker-node-gitbook:latest \
gitbook serve docs
Primero es necesario generar el compilado del Gitbook gitbook build
docker run -it --rm \
-v $(pwd):/docker-node-gitbook \
--name ${PWD##*/} docker-node-gitbook:latest \
gitbook build docs
Generar la imagen localmente con Nginx, para servir el Gitbook
Nota: Es necesario crear una copia del archivo
Dockerfile.prod
en el directorio que se creo para trabajar en el GitBook
docker build -t docker-node-gitbook-prod -f Dockerfile.prod .
docker run -it --rm \
-p 7000:80 \
--name ${PWD##*/} docker-node-gitbook-prod:latest
Siempre es necesario ingresar a la imagen para instalar alguna dependencia, componente, cambiar configuraciones, etc.
docker exec -ti ${PWD##*/} sh
El puerto del anfitrio es el 7000
, por lo que podemos accceder al contenido del libro mediante el navegador
http://localhot:70000
#o
http://0.0.0.0:70000