GitBook es una herramienta de línea de comandos basada en Node.js que soporta los formatos sintácticos Markdown y AsciiDoc, y puede generar libros electrónicos en HTML, PDF, eBook y otros formatos.
Instala node.js
Antes de usar la herramienta gitbook, el ordenador necesita instalar node.js entorno y, tras la instalación, puedes comprobar el comando de versión para comprobar si la instalación es exitosa:
Instalar Gitbook
Gitbook está instalado con npm, línea de comandos:
Ejecuta el comando de abajo para ver la versión de GitBook y verificar que la instalación ha sido exitosa.
Instalar versiones históricas
gitbook-cli facilita la descarga e instalación de otras versiones de GitBook para probar tus libros:
Usar gitbook ls-remote enumera las versiones que se pueden descargar.
Editor Markdown
Aquí usamos la sintaxis Markdown como lenguaje de escritura para nuestros documentos, necesitamos preparar un editor Markdown, podemos encontrar muchos editores Markdown en el mercado, como Typora, MacDown, Bear, MarkdownPad, MarkdownX, el IDE de JetBrains (requiere instalación de plugins), Atom, Jianshu, CSDN y el propio de GitBook GitBook Editor y demás.
Tengo instaladas herramientas de desarrollo de VS Code en mi ordenador, Vs Code soporta markdown por defecto, solo necesito instalar un artefacto del plugin de vista previa: Markdown Preview Enhanced, ¡y lo voy a usar!
Recomendado por amigos Editor tipográfico, dirección:El inicio de sesión del hipervínculo es visible.
Inicializar un libro
GitBook puede configurar un código estándar:
Si deseas crear un libro en un nuevo directorio, puedes hacerlo ejecutando gitbook init ./directory.
Tras la ejecución, verás dos archivos más: README.md y SUMMARY.md, que hacen lo siguiente:
README.md - La introducción del libro está escrita en este documento SUMMARY.md - La estructura del catálogo del libro está configurada aquí
No estoy familiarizado con la sintaxis de markdown, así que ¡escribe unas pocas frases!
Generar páginas web estáticas
Generar páginas web estáticas y ejecutar servidores
Todo lo anterior se generará en el catálogo de libros _book.
El comando de servicio también puede especificar el puerto:
Al generar, especifica la versión de gitbook y no se descargará localmente primero
Lista todas las versiones locales de gitbook
Lista las versiones de gitbook que estén disponibles de forma remota
Instala la versión correspondiente en gitbook
Actualización a la última versión de gitbook
Desinstala la versión correspondiente en gitbook
Especifica el nivel de logarítmic
Mensaje de error de salida
Resumen
GitBook utiliza archivos SUMMARY.md para definir la estructura de los capítulos y subcapítulos del libro. SUMMARY.md archivo se utiliza para generar el índice del libro.
El formato de SUMMARY.md es una lista de enlaces. El título del enlace servirá como título del capítulo, y el enlace estará dirigido al camino hacia ese archivo de capítulo.
Añadir una lista anidada al capítulo padre crea un capítulo hijo.
Ejemplo sencillo:
Luego volvemos a la línea de comandos y ejecutamos el comando init de gitbook de nuevo en la carpeta mybook. GitBook busca directorios y archivos descritos en SUMMARY.md archivos,Si no, se crea。
Salida de archivos PDF, ePub o mobi
Si quieres generar una versión pdf, puedes ejecutar gitbook pdf, de la misma manera que si exportas formato epub, gitbook epub, si es formato mobi, gitbook mobi servirá.
Si quieres exportar un e-book en formato PDF, ePub o mobi,Requiere Calibre Reader/Manager de eBook y herramientas de línea de comandos, de lo contrario se puede reportar un error "EbookError: Error durante la generación del ebook: 'ebook-convert'".
Características de los archivos especiales de GitBook:
archivo | descripción | | book.json | Datos de configuración (opcionales) | | README.md | Prólogo o introducción al eBook (obligatorio) | | SUMMARY.md | Catálogo de libros electrónicos (opcional) | | GLOSSARY.md | Lista de términos de vocabulario/anotación (opcional) | Configuración general de Gitbook
GitBook te permite personalizar tu ebook con configuraciones flexibles.
Estas opciones se especifican en el archivo book.json. Para autores que no estén familiarizados con la sintaxis JSON, puedes verificar la sintaxis usando herramientas como JSONlint.
variable | descripción | | raíz | La ruta hacia la carpeta raíz que contiene todos los archivos de libros, excepto book.json | | Estructura | Especifica rutas para readme, resúmenes, glosarios, etc | | Título | El título de tu libro, el valor predeterminado se extrae del README. En GitBook.com, este campo está prepoblado. | | descrip{filter}tion | La descripción de tu libro, el valor por defecto, se extrae del README. En GitBook.com, este campo está prepoblado. | | Autor | Nombre del autor. En GitBook.com, este campo está prepoblado. | | ISBN | ISBN | | Idioma | El tipo de idioma de este libro es el código ISO. El valor por defecto es en | | Dirección | Orden de lectura del texto. Puede ser RTL (de derecha a izquierda) o LTR (de izquierda a derecha), y el valor por defecto depende del valor del idioma. | | gitbook | Debe usarse la versión de GitBook. Utiliza la especificación SemVer y acepta condiciones similares a "> = 3.0.0". |
|