Este artículo tomado de "El Gran de rebajas" , Autor: BI problemas

Gran rebaja

GitBook es una herramienta de línea de comandos desarrollada basada en Node.js, que se puede utilizar para administrar fácilmente libros electrónicos.GitBook es actualmente la solución de escritura de libros de código abierto más popular.

El uso de GitBook permite a los creadores centrarse en la escritura y moverse libremente, sin tener que preocuparse demasiado por el diseño del contenido, la publicación y la gestión de versiones.

Además de administrar libros electrónicos a través de la línea de comandos de GitBook, también puede escribir y administrar libros electrónicos en línea ( gitbook.com ) o utilizando el editor de escritorio Gitbook Editor.

Para los novatos, recomiendo usar el Editor de Gitbook para escribir y administrar libros electrónicos, ya que integra las funciones del comando GitBook, el editor Markdown y Git, y el contenido se puede sincronizar con gitbook.com/Gitlab/GitHub a través de Git para una fácil gestión de versiones y Trabajo en equipo

Para programadores o personas familiarizadas con Git y Markdown, recomiendo usar la línea de comandos de GitBook + Typora + SourceTree para escribir y administrar libros electrónicos. Usar herramientas profesionales para hacer cosas profesionales es mucho más eficiente que Gitbook Editor.

GitBook es de código abierto, dirección: https://github.com/GitbookIO/gitbook

Características de GitBook:

Admite sintaxis Markdown o AsciiDoc
Puede exportar sitios estáticos o libros electrónicos (PDF, epub, mobi)
Soporta múltiples idiomas
Puede establecer cubierta
Soporta variables, plantillas y herencia de plantillas.
Hay complementos ricos

Portafolio de herramientas de GitBook:

Node.js: para instalar GitBook usando npm, primero debe instalar Node.js.
Comando GitBook: una herramienta de línea de comandos desarrollada basada en Node.js, utilizada para crear y administrar libros electrónicos.
Markdown: GitBook usa Markdown para escribir, y el autor ya no tiene que preocuparse por la composición tipográfica.
Git: GitBook usa Git para gestionar la escritura de contenido, facilitando la colaboración entre múltiples personas y la gestión de versiones.
Github / Gitlab: al igual que el código, el contenido escrito se puede alojar en Github o Gitlab.
gitbook.com : un sitio web para escribir, publicar y alojar libros electrónicos en línea.

Escenarios de uso de GitBook:

Construya la plataforma de documentos internos de una empresa para compartir datos dentro de la empresa.
Publique libros electrónicos de código abierto para compartir sus conocimientos en Internet para beneficiar al público.

Configuración del entorno de GitBook

Antes de comenzar, necesitamos instalar:

nodejs
gitbook

Instalar Node.js

Debido a que GitBook se desarrolla utilizando Node.js, debe instalarlo a través de la herramienta de administración de paquetes NPM Node.js, por lo que debe instalar Nodejs antes de comenzar.

Dirección de descarga de Node.js: https://nodejs.org/zh-cn/

NPM (administrador de paquetes de nodos), generalmente llamado administrador de paquetes de nodos. Use NPM para instalar, desinstalar, actualizar, ver, buscar y publicar paquetes de nodos.

Después de instalar Node.js, NPM se puede usar directamente.

Instalar GitBook

Herramienta de línea de comando para instalar GitBook usando NPM:

$ sudo npm install gitbook-cli -g

Una vez completada la instalación, verifique la versión de GitBook:

$ gitbook --version
CLI version: 2.3.0
GitBook version: 3.2.2

Actualizar el comando GitBook:

$ npm update gitbook-cli -g

Desinstalar el comando GitBook:

$ sudo npm uninstall gitbook-cli -g

Nota:

En este ejemplo, se usa el comando para instalar GitBook globalmente. Hay otra forma de instalar localmente. ¿Cuál es la diferencia entre los dos métodos?

Instalación local: el paquete de instalación se descargará en el directorio actual, por lo que solo se puede usar en el directorio actual.
Instalación global: el paquete de instalación se descargará a un directorio de sistema específico, y el paquete de instalación se puede usar en todos los directorios.

Por ejemplo, verifique dónde está instalada la instalación global en macOS.

$ which gitbook
/usr/local/bin/gitbook

GitBook se instala en el directorio / usr / local / bin /, por lo que puede usarse globalmente.

Este artículo tomado de "Guía Práctica de rebajas" Autor: Bi problemas

Inicio rápido GitBook

Inicializar GitBook

# 创建 mygitbook 文件夹，并切换到这个文件夹下面
~$ mkdir mygitbook && cd mygitbook

# 初始化 gitbook 工作目录，创建必要的文件
~$ gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished

Luego inicializará el directorio de GitBook y creará dos archivos de formato md README.md y SUMMARY.md

README.md -La descripción del proyecto está escrita en este archivo.
SUMMARY.md : la estructura de directorios de GitBook se configura aquí.

Definir la estructura del directorio.

Dos métodos

Hay dos formas de definir la estructura de directorios en el archivo Summary.md .

Método First. Primero defina la estructura del directorio, y genere automáticamente la carpeta y el archivo Markdown correspondiente a la estructura del directorio a través de gitbook init.

Método First. Primero cree una carpeta y un archivo Markdown y luego edite la estructura del directorio.

SUMMARY.md

¿Cómo se ve la estructura de directorios de SUMMARY.md ? Ver abajo:

# Summary

* [项目简介](README.md)
* [快速开始](docs/快速开始.md)
 * [环境搭建](docs/环境搭建.md)
 * [简单使用](docs/简单使用.md)
* [学入学习](docs/深入学习)

Después de crear este directorio, ejecute el comando en el directorio raíz:

~$ gitbook init

Se crearán los directorios y archivos que no estén disponibles:

info: create docs/快速开始.md
info: create docs/环境搭建.md
info: create docs/简单使用.md
info: create docs/深入学习.md
info: create SUMMARY.md
info: initialization is finished

Nota: gitbook init solo admite generar dos niveles de directorios

Iniciar servicio

Ejecute el comando en el directorio raíz:

~$ gitbook serve

El resultado:

Live reload server started on port: 35729
Press CTRL+C to quit ...

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 5 pages
info: found 0 asset files
info: >> generation finished with success in 1.9s !

Starting server ...
Serving book on http://localhost:4000 # 注意浏览地址

Ejecutar gitbook serveel comando, primero compilar los libros gitbook build, si no hay ningún problema para abrir un servidor Web, el puerto por defecto 4000 para escuchar. Si hay un problema con la compilación, se lanzará un mensaje de error.