Слияние кода завершено, страница обновится автоматически
Gitbook — это инструмент командной строки, который позволяет объединить ваши файлы Markdown в электронную книгу и предоставить вывод в различных форматах, таких как PDF. Вы можете опубликовать HTML-версию, созданную Gitbook, и получить простой статический веб-сайт. Gitbook также имеет одноимённую платформу (gitbook.io), где можно публиковать и продавать электронные книги, а также предоставляет инструмент Markdown для помощи в написании (поддерживает Mac, Windows и Linux). Вот мои заметки об использовании Gitbook.
Прежде всего, Gitbook не имеет ничего общего с Git/Github. Это просто инструмент для создания книг. Но его префикс Git может вызвать путаницу у многих людей. Сначала я думал, что это ещё одна платформа Git, похожая на Github, но на самом деле это не так. Вам нужно только понимать несколько синтаксических правил Markdown, чтобы использовать Gitbook без необходимости разбираться в чём-либо, связанном с Git. Не позволяйте названию сбивать вас с толку.
Шаг 0: Установите npm (Node Package Manager). Загрузите и установите программу установки с сайта node.js, чтобы завершить установку Node.js и npm.
Шаг 1: Установите Gitbook через npm.
$ npm install gitbook -g
После этого потратьте 10 минут на чтение документации по Gitbook (http://help.gitbook.io/). Если у вас нет терпения читать руководство, продолжайте читать дальше :D
Шаг 2: Изучите основные правила Gitbook.
Gitbook требует двух основных файлов:
README.md содержит информацию о вашей книге, а SUMMARY.md включает оглавление, которое примерно выглядит следующим образом:
* [Глава 1](c1.md)
* [Раздел 1](c1s1.md)
* [Раздел 2](c1s2.md)
* [Глава 2](c2.md)
Остальное довольно понятно. После написания соответствующих разделов вы можете запустить следующую команду:
$ gitbook serve -p 8080 .
Сначала Gitbook компилирует ваши файлы Markdown в HTML и генерирует каталог книги на основе SUMMARY.md. Все существующие файлы сохраняются в подкаталоге с именем _book в текущем каталоге. После выполнения этих задач Gitbook запускается как HTTP-сервер и прослушивает HTTP-запросы на порту 8080.
Запустив эту команду, откройте браузер и введите в адресной строке http://localhost:8080, чтобы увидеть страницу вашей книги.
Раздел «Введение» в верхней части левой панели навигации скомпилирован из README.md, а оглавление — из SUMMARY.md. Чтобы опубликовать новую книгу на своём сайте, просто скопируйте подкаталог _book на соответствующий сервер. На этом базовое использование Gitbook завершено. Ниже мы кратко обсудим другие функции Gitbook, включая плагины, интеграцию с Github, клиент Gitbook, платформу Gitbook и проблемы Gitbook.
Поскольку Gitbook может генерировать HTML, он поддерживает некоторые внешние файлы JavaScript, такие как Google Analytics и Disqus для комментариев. В качестве примера рассмотрим добавление Disqus в вашу книгу.
Во-первых, установите плагин Gitbook Disqus.
$ npm install gitbook-plugin-disqus
Затем создайте файл book.json со следующим содержимым:
{ "plugins": ["disqus"], "pluginsConfig": { "disqus": { "shortName": "NAME-FROM-DISQUS" } } }
Измените NAME-FROM-DISQUS на имя вашего проекта на Disqus.
Снова запустите команду:
$ gitbook serve -p 8080 .
Обновите браузер, чтобы увидеть страницу с комментариями Disqus.
Согласно блогу Gitbook, Github предлагает специальную поддержку для Gitbook, но я её не тестировал. Просто сохраните исходные файлы на Github и используйте Gitbook для компиляции. Надеюсь, Gitbook станет лучше.
Клиент Gitbook поддерживает Mac, Windows и Linux. Я попробовал этот клиент на Mac и Windows, и в целом он работает нормально. Однако это просто базовый функционал. Вы можете редактировать файлы Markdown и просматривать их в реальном времени; связать свой аккаунт Gitbook и синхронизировать контент с gitbook.io, а также создавать PDF и другие форматы. Кстати, если вам нужен клиент Markdown, то MarkedUp лучше, особенно с поддержкой Vim.
Сайт Gitbook загружается медленно. После создания каталога _book вы можете скопировать HTML-файлы и подкаталог gitbook (включая шрифты и файлы JavaScript) на свой сайт.
Функция push Gitbook не работает. Адрес push.gitbook.io недоступен, возможно, это временная проблема с сервисом.
Шрифты на китайском языке в PDF, созданных Gitbook, выглядят ужасно. Жду улучшений. С другой стороны, китайский текст на HTML-страницах Gitbook выглядит великолепно.
Когда я просматриваю страницы Gitbook на своём телефоне, браузер зависает.
В прошлый раз я говорил о создании электронных книг с использованием GitBook (http://www.ituring.com.cn/article/127645), сосредоточившись на использовании инструмента командной строки Gitbook. Сегодня основное внимание уделяется платформе Gitbook. После размещения книги на Gitbook вы можете установить цену (GitBook получает 20% комиссионных за каждую продажу), сделать её бесплатной или принимать пожертвования. Если вы хотите взимать плату или принимать пожертвования, вам понадобится учётная запись PayPal. Прежде чем начать, хочу напомнить, что доступ к GitBook из Китая очень медленный, и вам потребуется VPN.
Шагу 0: Используйте Git для управления вашими файлами Markdown. Лучше иметь учётную запись GitHub, тогда каждый раз, когда вы отправляете изменения на GitHub, GitBook автоматически создаёт новую версию на основе ваших обновлений (одновременно создавая HTML, PDF, ePUB и MOBI).
Шагу -1: Зарегистрируйте учётную запись GitBook.
Шагу 1: Добавьте книгу в GitBook, заполнив основную информацию. После завершения GitBook создаст репозиторий Git для вашей книги в формате:
author — ваше имя пользователя GitBook, book — название вашей книги, например, мой репозиторий для книги:
Вы можете отправлять свои файлы Markdown после завершения работы, используя git push.
Шагу 2: Отправьте ваши локальные файлы Markdown на GitBook. Я обнаружил, что git push часто завершается ошибкой (сервер возвращает ошибку 5xx), поэтому есть ещё один способ — связать ваш локальный репозиторий с GitBook. Каждый раз, когда вы отправляете обновления на GitHub, они будут автоматически синхронизироваться с GitBook через веб-хук.
Настройте это в Book Setting, как в моём случае: berlinix/gdu (мой пользователь GitHub — berlinix, а репозиторий GitHub — gdu).
После первой отправки вы увидите свою книгу на GitBook, и её адрес будет:
http://{author}.gitbooks.io/{book}/
Это главная страница вашей книги, откуда вы можете напрямую открыть HTML-версию или загрузить PDF и другие версии электронных книг, и обычные пользователи могут оставлять комментарии к вашей книге. Например:
Чтобы напрямую перейти к HTML-версии, используйте ссылку:
Перейдите непосредственно, например:
Теперь, когда мы рассмотрели основы использования GitBook, вот несколько советов из моего опыта.
URL-адрес HTML-версии довольно сложен, и вы можете упростить его, используя персонализированный домен. Добавьте запись CNAME в регистраторе доменов, указав:
CNAME gdu.berlinix.com www.gitbook.io 300
И настройте gdu.berlinix.com в Book Settings, чтобы вы могли использовать простой gdu.berlinix.com, а не https://www.gitbook.io/read/book/berlinix/guaidanuniversity. Аналогично, вы можете настроить главную страницу электронной книги с персонализированным доменом.
Также в Book Settings вы можете удалить электронную книгу. Нет интерфейса удаления в списке электронных книг.
Добавьте обложку к своей электронной книге. Просто добавьте два изображения с именами cover.jpg и cover_small.jpg. Официально рекомендуется, чтобы размер cover.jpg был 1800 * 2360, а размер cover_small.jpg — 200 * 262. За 2 юаня вы можете найти кого-то, кто сделает простую обложку для вас на Taobao, или больше, если она сделана хорошо :)
А здесь перевод заканчивается, так как далее идёт информация о настройке аватара для учётной записи GitBook, которая не относится к технической сфере разработки программного обеспечения. Похоже, что принимаются только аватары с Gravatar.com. Нужно просто связать свой аккаунт с Gravatar. Сервис Gravatar позволяет связать ваш электронный адрес и аватар, так что при регистрации на других сайтах вам не нужно каждый раз загружать один и тот же аватар — достаточно просто связать его с аккаунтом Gravatar. Это также упрощает замену аватара — она происходит единожды и действует везде.
Оптимизация доступа
Если люди будут заходить на HTML-страницы GitBook, то это будет путь к самоуничтожению. Поэтому лучше всего разместить скомпилированный HTML GitBook на своём собственном сайте. Также для HTML своего сайта можно создать поддержку Disqus. Например, вы можете зайти на страницу, которую я разместил на своём сервере (эффект от посещения через мобильный телефон также очень хороший):
Баги в электронных книгах
Ранее я говорил, что китайские иероглифы в PDF, генерируемом GitBook, выглядят ужасно. Кроме того, есть ещё одна проблема: сгенерированный PDF может быть неполным. После компиляции я обнаружил, что осталась только половина содержимого. Я уже отправил сообщение об этом баге по электронной почте и всё ещё жду ответа :)
В целом, GitBook — это очень забавная штука. По сравнению с другими платформами для написания, он более свободный, простой и удобный. Можно использовать Vim для редактирования, поддерживается синтаксис Markdown, используется git для управления, а после каждого push можно автоматически компилировать и генерировать электронные книги в различных форматах. Если ваша книга пользуется большим спросом, вы даже можете получать пожертвования или продажи. Нет причин не попробовать!
Источники:
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )