gitbook-start-alex-moi-nitesh

Module to build a book on GitBook


Keywords
gitbook, npm package
License
ISC
Install
npm install gitbook-start-alex-moi-nitesh@1.2.53

Documentation

Sistemas y Tecnologías Web. Creación de Paquete en NodeJS.

Introducción

El objetivo de esta práctica es crear un package NodeJS y publicarlo en npm. El paquete se construye a partir de el código que haya desarrollado en la práctica anterior.

##Tutorial para su instalación

Instalar el paquete

npm install -g gitbook-start-alex-moi-nitesh
npm install --save gitbook-start-alex-moi-nitesh

Creación de directorio

gitbook-start-alex-moi-nitesh -d [nombre directorio]

##Tutorial para su ejecución

Para ejecutar, ponemos el siguiente comando:

gitbook-start-alex-moi-nitesh [opciones]

[opciones]

  • -a: Especificar el autor del gitbook
  • -n: Especificar el nombre del gitbook
  • -d: Especificar el nombre del directorio(Obligatorio)
  • -u: Especificar la url del repositorio git
  • -h: Help (ayuda)

Después de ejecutar el comando se genera una estructura de directorios para poder desarrollar un gitbook y publicarlo en github.

La estructura que genera es similar a la siguiente:

enter image description here

Una vez instalado y ejecutado, desde el directorio generado (Book en la imagen anterior) hacemos:

npm install

Una vez completado los "ficheros.md" de nuestro book, para construirlo y publicarlo hacemos:

gulp build
gulp deploy

Donde gulp build nos generará un directorio gh-pages con el contenido del gitbook, es decir, los ficheros html creados a partir de los markdowns. Por otro lado, con gulp deploy, publicamos el contenido de dicho directorio en la rama gh-pages del repositorio git.

Un ejemplo de la versión final del gitbook sería: Ejemplo

Enlaces importantes

Autores

Universidad de La Laguna