hugo book

Тема книги Хьюго — ГОРЯЧАЯ вилка

Тема документации Хьюго проста, как обычная книга

Функции

• Чистый простой дизайн

• Удобство для мобильных устройств

• Настраиваемый

• Разработан так, чтобы не мешать другим макетам.

• Нулевая начальная конфигурация

Требования

• Хьюго 0,43 или выше

• Расширенная версия Hugo, подробнее здесь.

Установка

Перейдите в корень вашего веб-сайта Hugo и запустите:

git submodule add https://github.com/alex-shpak/hugo-book themes/book

Затем запустите Hugo (или установите theme: book в файле конфигурации)

hugo server --theme book

Меню

Меню дерева файлов (по умолчанию)

По умолчанию тема отображает страницы из раздела content/docs в виде меню в древовидной структуре.
Вы можете установить title и weight в начале страниц, чтобы настроить порядок и заголовки в меню.

Меню пакета листьев

Вы также можете использовать листовой пакет и содержимое его index.md в качестве меню.

Учитывая, что у вас есть эта файловая структура

├── content
│   ├── docs
│   │   ├── page-one.md
│   │   └── page-two.md
│   └── posts
│       ├── post-one.md
│       └── post-two.md

Создайте файл content/docs/menu/index.md с содержимым.

 ---headless: true---- [Пример книги](/docs/)
  - [Первая страница](/docs/page-one)
  - [Страница вторая](/docs/page-two)- [Блог](/posts)

И включите его в настройках BookMenuBundle: /docs/menu в конфигурации сайта.

• Пример меню

• Пример файла конфигурации

• Пучки листьев

Блог

Простой блог, поддерживаемый для posts в разделах.

Конфигурация

Конфигурация сайта

Есть несколько параметров конфигурации, которые вы можете добавить в файл config.yml|json|toml

 # (Необязательно) Установите для этого значения значение true, если вы используете заглавные буквы в именах файловdisablePathToLower: true# (Необязательно) Установите для этого значения значение true, чтобы включить дату «Последнее изменение» и информацию об авторе # git на страницах типа «doc».enableGitInfo: true# (Предупреждения) Тема предназначена для использования в документации, поэтому она не отображает таксономию.# Вы можете скрыть соответствующее предупреждение с помощью конфигурации нижеdisableKinds: ["taxonomy", "taxonomyTerm"]params: # (Необязательно, по умолчанию true) Показать или скрыть оглавление глобально
  # Вы также можете указать этот параметр для каждой страницы в начале страницы
  БукШоуТоК: правда

  # (Необязательно, по умолчанию нет) Установить пакет листьев для отображения в виде бокового меню.
  # Если не указана структура файла и вес, будут использоваться
  BookMenuBundle: /menu

  # (Необязательно, документы по умолчанию) Укажите раздел контента для отображения в виде меню.
  # Вы также можете установить значение «*», чтобы отобразить все разделы в меню.
  BookSection: документы

  # Это значение является дубликатом $link-color для выделения активной ссылки в режиме пакета меню.
  # BookMenuBundleActiveLinkColor: #004ed0

  # Включаем JS-скрипты на страницы. По умолчанию отключено.
  # - Сохранять боковое меню в том же положении прокрутки во время навигации
  BookEnableJS: правда

  # Установите местоположение исходного репозитория.
  # Используется для ссылок «Последнее изменение» и «Редактировать эту страницу».
  BookRepo: https://github.com/alex-shpak/hugo-book

  # Включить ссылки «Редактировать эту страницу» для типа страницы «документ».
  # По умолчанию отключено. Раскомментируйте, чтобы включить. Требуется параметр BookRepo.
  # Путь должен указывать на каталог «content» репозитория.
  BookEditPath: изменить/мастер/exampleSite/содержание

Конфигурация страницы

Вы можете указать дополнительные параметры на странице во вступительной части.

 ---# Установите тип "docs", если вы хотите отображать страницу за пределами настроенного раздела или если вы отображаете раздел, отличный от типа "docs": docs# Установите вес страницы, чтобы переупорядочить элементы в меню дерева файлов (если BookMenuBundle не установлено)weight: 10# (Необязательно) Установите, чтобы пометить страницу как плоский раздел в меню дерева файлов (если BookMenuBundle не установлен)bookFlatSection: true# (Необязательно) Установите, чтобы скрыть оглавление, переопределяет глобальное valuebookShowToC: false ---

Частичные

Есть несколько пустых партиалов, которые вы можете переопределить в layouts/partials/

Частичный	Размещение
layouts/partials/docs/inject/head.html	Перед закрытием тега <head>
layouts/partials/docs/inject/body.html	Перед закрытием тега <body>
layouts/partials/docs/inject/menu-before.html	В начале блока меню <nav>
layouts/partials/docs/inject/menu-after.html	В конце блока меню <nav>

Содействие

Вклады приветствуются, и я рассмотрю и рассмотрю запросы на включение.
Основные цели:

• Будьте проще

• Сохраняйте минимальную (или нулевую) конфигурацию по умолчанию.

• Избегайте вмешательства в пользовательские макеты

Не стесняйтесь открывать проблему, если вам не хватает какой-либо опции конфигурации или настройки.

Лицензия

Массачусетский технологический институт