Skip to content

phpshopsoftware/gitbook2site

Repository files navigation

GitBook2Site

GitBook2Site - это простая оболочка для отображения документации из файлов в формате Markdown, полученных с GitBook.

Копирует всю структуру и ссылки с GitBook, позволяет выполнять обновление данных по расписанию и производить поиск данных.

Структура

  • /help-main/ - исходники файлов с GitBook
  • /config.php - файл настроек
  • /update-sample.sh - заготовка для файла обновления данных.
  • /template/default/template.tpl.php - HTML шаблон вывода на Bootstrap

Назначение

Делает зеркало документации без задержек в загрузке, без блокировки ресурсов и возможностью изменять отображения данных, иметь полный доступ к файлам (установки счетчиков, чатов и т.д.).

Требования

  • PHP 7, 8

Установка

  • Скачать и распаковать файлы GitBook2Site в корневую папку сайта
  • Создать проект GitBook и настроить синхронизацию с GitHub
  • Выгрузить исходники проекта с GitHub в виде архива и распаковать в папку /help-main/
  • Настроить синхронизацию данных с GitHub с помощью update-sample.sh (требуется указать свои данные)

Библиотеки

ОС

  • Linux , macOS
  • Windows - необходимо переименовать папку в исходниках /help-main/.gitbook в /help-main/_gitbook из-за невозможности отображать изображения с точкой в путях в Windows

Плюсы

  • Нет блокировки ресурсов gitbook.io
  • Использование своего доменного имени на бесплатном тарифе GitBook Free
  • Работает на любом тарифе популярных хостингов без установки стороннего ПО
  • На порядок быстрее загружается и отображается содержимое
  • Оптимизация для SEO
  • Простой файл шаблона на Bootstrap
  • Возможность подключения Яндекс.Метрики и других виджетов статистики или чатов

Демо

About

PHP скрипт для публикации и отображения файлов из Gitbook. Создает зеркало Gitbook на сайте.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages