GitBook е Node.js-базиран команден инструмент, който поддържа синтактични формати Markdown и AsciiDoc и може да изводи електронни книги в HTML, PDF, eBook и други формати.
Инсталирай node.js
Преди да използвате gitbook инструмента, компютърът трябва да инсталира node.js среда, а след инсталацията можете да проверите командата version, за да проверите дали инсталацията е успешна:
Инсталирай Gitbook
Gitbook се инсталира с npm, команден ред:
Изпълнете командата по-долу, за да видите версията на GitBook и да проверите дали инсталацията е успешна.
Инсталирайте исторически версии
gitbook-cli улеснява изтеглянето и инсталирането на други версии на GitBook, за да тествате книгите си:
С помощта на gitbook ls-remote изброява версиите, които могат да бъдат изтеглени.
Редактор на Markdown
Тук използваме синтаксиса на Markdown като език за писане на нашите документи, трябва да подготвим редактор за Markdown, можем да намерим много редактори на пазара, като Typora, MacDown, Bear, MarkdownPad, MarkdownX, IDE на JetBrains (изисква инсталиране на плъгин), Atom, Jianshu, CSDN и собствения на GitBook GitBook Editor и така нататък.
Имам инсталирани инструменти за разработка на VS код на компютъра си, VS Code поддържа 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: Грешка при генериране на електронна книга: 'ebook-convert'".
Функции на GitBook Special Files:
Файл | описание | | 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 ч.
|
|
|
|
