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 код підтримує markdown за замовчуванням, мені потрібно лише встановити артефакт плагіна прев'ю: Markdown Preview Enhanced, і я ним скористаюся!
Рекомендовано друзями Редактор typora, адреса:Вхід за гіперпосиланням видно.
Ініціалізація книги
GitBook може налаштувати шаблонний шаблон:
Якщо ви хочете створити книгу в новому каталогу, це можна зробити за допомогою gitbook init ./directory.
Після виконання ви побачите ще два файли — README.md і SUMMARY.md, які роблять наступне:
README.md - Вступ до книги написано в цьому документі
SUMMARY.md - Структура каталогу книги налаштована тут
Я не знайомий із синтаксисом markdown, тож просто напишіть кілька речень!
Генерація статичних веб-сторінок
Генеруйте статичні веб-сторінки та запускайте сервери
Усе вищезазначене буде згенеровано у каталозі книг _book.
Команда подачі також може вказати порт:
При створенні вкажіть версію gitbook, і вона не буде завантажена локально спочатку
Містить список усіх локальних версій gitbook
Перелічіть версії gitbook, доступні віддалено
Встановіть відповідну версію gitbook
Оновлення до останньої версії gitbook
Видалити відповідну версію gitbook
Визначає рівень log
Повідомлення про помилку виводу
Резюме
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: Error during epbook generation: '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
|
|
|
|
