gitbook-start-github-rafadanipedro

3.0.0 • Public • Published

Práctica: GitHub API, Heroku API y SSH en JavaScript. Práctica 6 de SYTW

Version NPM

En esta práctica trabajaremos sobre los anteriores paquetes en los que deplegábamos un Gitbook en Heroku e IAAS. En este caso, se nos pide crear un plugin para desplegar en Github que, utilizando la API de Github, sea capaz de crear un repositorio y publicarlo.

Funcionamiento paquete

Para esta práctica hemos creado un nuevo paquete, disponible en el siguiente enlace.

Lo primero, debemos de instalar dicho paquete de manera global, ejecutando el siguiente comando: npm i -g gitbook-start-github-rafadanipedro. Una vez instalado, simplemente ejecutamos gitbook-start <nombreLibro>, lo que nos creará la estructura del libro. A continuación, se nos pedirá por pantalla el nombre de usuario y la contraseña (de manera oculta) de GitHub para obtener el token de nuestro perfil y así poder crear un repositorio al que subir el libro de manera totalmente automática y transparente para el cliente.

Las opciones que puede recibir el paquete son:

--author: especifica el autor del libro. Por defecto es el nombre de usuario de GitHub.
--email: especifica el email del autor del libro. Por defecto es el correo de usuario de git.
--license: especifica la licencia del libro. Por defecto es "MIT".
--repo: especifica la direccion del repositorio de GitHub. Por defecto es "https://github.com/'+nombreUsuario/'+nombreRepo".
--ghPages: especifica la direccion en la que se encuentran las gh-pages generadas. Por defecto es "http://'+nombreUsuario.github.io/'+nombreRepo".
--name: especifica el nombre del libro. Por defecto este argumento es obligatorio.
--title: especifica el titulo del libro. Por defecto es el mismo que el nombre del libro.
--description: especifica la descripcion del libro. Por defecto es "Descripcion breve del Gitbook".
--outputDirName: nombre del directorio a crear. Por defecto es el nombre del libro.
-d o --deploy: despliega el libro en el plugin que le indique

Es obligatorio especificar un nombre para el libro, ya que es el único argumento obligatorio.

Ejemplo: gitbook-start mi_libro --author Joselito --email joselito@chuchu.com

Descripción de la práctica

Páginas personales

Pinchando sobre las imágenes podrás acceder a nuestras páginas personales.

postimage postimage postimage

Readme

Keywords

Package Sidebar

Install

npm i gitbook-start-github-rafadanipedro

Weekly Downloads

10

Version

3.0.0

License

MIT

Last publish

Collaborators

  • rafadanipedro