GitBook — это инструмент командной строки на базе Node.js, поддерживающий синтаксические форматы Markdown и AsciiDoc, а также способный выводить электронные книги в форматах HTML, PDF, eBook и других форматах.
Установите node.js
Перед использованием инструмента Gitbook компьютер должен установить node.js среду, а после установки можно проверить команду версии, чтобы проверить, успешная ли установка:
Установка Gitbook
Gitbook устанавливается с npm, командная строка:
Выполните команду ниже, чтобы увидеть версию GitBook и убедиться, что установка прошла успешно.
Установка исторических версий
gitbook-cli облегчает скачивание и установку других версий GitBook для тестирования ваших книг:
С помощью gitbook ls-remote перечисляет версии, которые можно скачать.
Редактор Markdown
Здесь мы используем синтаксис Markdown как язык письма для наших документов, нам нужно подготовить редактор Markdown, мы можем найти множество редакторов Markdown на рынке, таких как Typora, MacDown, Bear, MarkdownPad, MarkdownX, IDE от JetBrains (требует установки плагина), Atom, Jianshu, CSDN и собственный редактор GitBook GitBook Editor и так далее.
У меня на компьютере установлены инструменты для разработки VS-кода, VS Code поддерживает markdown по умолчанию, мне нужно только установить артефакт плагина Preview Enhanced: Markdown Preview Enhanced, и я буду им пользоваться!
Рекомендовано друзьями. Редактор typora, адрес:Вход по гиперссылке виден.
Инициализация книги
GitBook может настроить шаблонную таблицу:
Если вы хотите создать книгу в новой директории, вы можете сделать это, запустив gitbook init ./directory.
После выполнения вы увидите ещё два файла — README.md и SUMMARY.md, которые делают следующее:
README.md - Введение к книге написано в этом документе
SUMMARY.md - Структура каталога книги настроена здесь
Я не знаком с синтаксисом markdown, так что просто напишите пару предложений!
Генерируйте статические веб-страницы
Генерируйте статические веб-страницы и запускайте серверы
Всё вышеперечисленное будет сгенерировано в книжном каталоге _book.
Команда подачи также может указывать порт:
При генерации указывайте версию gitbook, и она не будет скачана локально сначала
Список всех локальных версий gitbook
Перечислите версии gitbook, доступные удалённо
Установите соответствующую версию Gitbook
Обновление до последней версии gitbook
Удалите соответствующую версию gitbook
Задаёт уровень логарифма
Сообщение об ошибке вывода
Краткое содержание
GitBook использует SUMMARY.md файлы для определения структуры глав и подглав книги. SUMMARY.md File используется для создания оглавления книги.
Формат SUMMARY.md представляет собой список ссылок. Название ссылки служит названием главы, а ссылка будет направлена на путь к файлу главы.
Добавление вложённого списка в родительскую главу создаёт дочернюю главу.
Простой пример:
Затем возвращаемся в командную строку и снова запускаем команду gitbook init в папке mybook. GitBook ищет каталоги и файлы, описанные в SUMMARY.md файлах,Если нет — он создаётся。
Вывод файлов PDF, ePub или mobi
Если хотите сгенерировать pdf-версию, можно запустить gitbook pdf так же, как если вы экспортируете формат epub, gitbook epub, если это формат mobi — подойдёт gitbook mobi.
Если вы хотите экспортировать электронную книгу в форматах PDF, ePub или mobi,Требуется Calibre eBook Reader/Manager и инструменты командной строки, в противном случае может быть зафиксирована ошибка «EbookError: Ошибка при генерации электронной книги: 'ebook-convert'».
Особенности специальных файлов GitBook:
Файл | описание | | book.json | Данные конфигурации (опционально) | | README.md | Предисловие или введение к электронной книге (обязательно) | | SUMMARY.md | Каталог электронных книг (по желанию) | | GLOSSARY.md | Список терминов с лексикой/аннотацией (по желанию) |
Общие настройки Gitbook
GitBook позволяет настраивать вашу электронную книгу с помощью гибких конфигураций.
Эти опции указаны в файле book.json. Для авторов, не знакомых с синтаксисом JSON, можно проверить синтаксис с помощью таких инструментов, как JSONlint.
переменная | описание | | корень | Путь к корневой папке, содержащей все файлы книг, кроме book.json | | Структура | Укажите пути для readme, аннотации, глоссариев и т.д. | | Название | Название вашей книги по умолчанию извлекается из README. На GitBook.com это поле предварительно заполнено. | | descrip{filter}tion | Описание вашей книги, значение по умолчанию извлечено из README. На GitBook.com это поле предварительно заполнено. | | Автор | Имя автора. На GitBook.com это поле предварительно заполнено. | | ISBN | ISBN | | Язык | Языковой тип этой книги — ISO-код. Значение по умолчанию — en | | Режиссура | Порядок чтения текста. Это может быть RTL (справа налево) или LTR (слева направо), а значение по умолчанию зависит от значения языка. | | gitbook | Стоит использовать версию для GitBook. Используйте спецификацию SemVer и принимайте условия, похожие на «> = 3.0.0». |
|
Опубликовано 23.11.2018 14:03:54
|
|
|
|
