Создавайте документы с помощью Gitbook и экспортируйте PDF-файлы

Spring Boot

экспортPDFЕсть много способов, которые использовались раньше马克飞象Функция экспорта, а просто простой экспорт не добавляет каталог, потому что исходный файлmarkdownНаписано, отфильтровано и принятоgitbookспособ документирования и использованияgitbook pdf .способ экспорта какPDFдокумент.

Примечание. Эта машина должна иметьNodeJsокружающая обстановка.

Оригинальный пост в блоге:блог с книгой rest.com/use-git…

Подготовка окружающей среды

хочу использоватьgitbook, то нам нужно установить его локально, черезnpmКоманды могут быть легко установлены.

Установить Гитбук

пройти черезnpmспособ установкиgitbookсреде команда выглядит следующим образом:

npm install gitbook -g

Установите калибр и конвертируйте электронные книги

использоватьgitbookДля функции экспорта требуется сторонний плагинebookПоддержка следующей конфигурации среды для двух разных операционных систем.

Linux-система

ссылка для скачивания:руб libre-eBook.com/download_li…

  • Загрузить и установить
  sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.sh | sudo sh /dev/stdin

  • Настройка программных ссылок
  sudo ln -s /usr/bin/nodejs /usr/bin/node

Система Mac

ссылка для скачивания:стереть libre-eBook.com/download_OS…

  • Загрузить и установить

загружен какdmgПросто дважды щелкните файл, чтобы установить его.

  • Настройка программных ссылок
  sudo ln -s ~/Applications/calibre.app/Contents/MacOS/ebook-convert /usr/bin

тестовая установка

После завершения установки выполните следующую команду, чтобы проверить, вступила ли она в силу.

ebook-convert --version

Создание документации

новенькийgitbookДокумент состоит из двух файлов, а именноREADME.md,SUMMARY.md(Вы можете создать папку самостоятельно и создать эти два файла в папке).

  • README.md: Подробное описание текущего документа
  • SUMMARY.md: конфигурация иерархии каталогов текущего документа, которая может быть напрямую сгенерирована командой инициализации.markdownфайлы и папки.

Написать резюме

Вот иерархия примера документа:

# Summary

- 第一级目录
  - [第一级目录的子目录](one/first.md)
- 第二级目录
  - [第二级目录的子目录](two/first.md)

Инициализация GitBook

gitbookКоманда инициализации предоставляется внутри автоматически в соответствии сSUMMARY.mdИерархическое содержимое файла генерирует соответствующийmdфайлы и папки, выполните следующие команды:

➜ gitbook-example gitbook init
info: create one/first.md 
info: create two/first.md 
info: create SUMMARY.md 
info: initialization is finished

Вывод консоли уже говорит нам, что она успешно созданаone/first.md,two/first.mdэти два файла.

язык конфигурации

gitbookНе используется по умолчанию中文汉子, нам нужно настроитьbook.jsonфайл для изменения языкового режима по умолчанию (book.jsonфайл, созданный вSUMMARY.mdв каталоге того же уровня) следующим образом:

{
    "language": "zh-hans"
}

экспортный документ

gitbookСуществует множество способов экспорта документов. Ниже приводится краткое описание некоторых методов экспорта.

Экспорт в PDF

существуетSUMMARY.mdРодственный каталог файла выполняетсяgitbook pdf .команда для экспортаPDFфайл, журнал выполнения выглядит так:

➜ gitbook-example gitbook pdf .
info: 7 plugins are installed 
info: 6 explicitly listed 
info: loading plugin "highlight"... OK 
info: loading plugin "search"... OK 
info: loading plugin "lunr"... OK 
info: loading plugin "sharing"... OK 
info: loading plugin "fontsettings"... OK 
info: loading plugin "theme-default"... OK 
info: found 3 pages 
info: found 0 asset files 
info: >> generation finished with success in 5.7s ! 
info: >> 1 file(s) generated

Если вы хотите настроить сгенерированныйpdfимя файла, вы можете использоватьgitbook pdf . ./xxxx.pdfЗаказ.

экспортировать как epub

существуетSUMMARY.mdРодственный каталог файла выполняетсяgitbook epub .команда для экспортаepubфайл, журнал выполнения выглядит так:

➜ gitbook-example gitbook epub .
info: 7 plugins are installed 
info: 6 explicitly listed 
info: loading plugin "highlight"... OK 
info: loading plugin "search"... OK 
info: loading plugin "lunr"... OK 
info: loading plugin "sharing"... OK 
info: loading plugin "fontsettings"... OK 
info: loading plugin "theme-default"... OK 
info: found 3 pages 
info: found 2 asset files 
info: >> generation finished with success in 2.4s ! 
info: >> 1 file(s) generated

экспортировать в моби

существуетSUMMARY.mdРодственный каталог файла выполняетсяgitbook mobi .команда для экспортаmobiфайл, журнал выполнения выглядит так:

➜ gitbook-example gitbook mobi .
info: 7 plugins are installed 
info: 6 explicitly listed 
info: loading plugin "highlight"... OK 
info: loading plugin "search"... OK 
info: loading plugin "lunr"... OK 
info: loading plugin "sharing"... OK 
info: loading plugin "fontsettings"... OK 
info: loading plugin "theme-default"... OK 
info: found 3 pages 
info: found 3 asset files 
info: >> generation finished with success in 1.9s ! 
info: >> 1 file(s) generated

Экспорт журнала

Если у вас возникнут проблемы в процессе экспорта, вы можете добавить--log=debugПараметры команды, чтобы вы могли видеть полный вывод информации журнала в консоли при экспорте, как показано ниже:

➜ gitbook-example gitbook pdf . ./example.pdf --log=debug
debug: readme found at README.md 
debug: summary file found at SUMMARY.md 
debug: cleanup folder "/var/folders/c1/5mrhntb13_zfrnjg4grnf8zr0000gn/T/tmp-2291a4Jd8P8oNX4l" 
......

Суммировать

использоватьgitbookЕго можно использовать для написания документации по использованию интерфейса компании, документации по дизайну проекта и т. д. Эта функция гораздо шире.gitbook buildкоманда для создания статикиhtmlфайл, который можно развернуть наNginx,阿里云OSSи т. д., где размещены статические страницы.

автор личноблог

Используйте фреймворк с открытым исходным кодомApiBootПомочь вам стать архитектором сервисов интерфейса API

Категории