Hugo. Wowchemy. Book

Использование узла типа book.

1 Общая информация

• Тип узла book используется для создания многостраничного контента, такого как онлайн-курсы, документация по программному обеспечению, базы знаний, книги, блокноты, учебные пособия.

2 Структура

• Предлагается использовать следующую файловую структуру:

 1content/course
 2├── _index.md         # Overview
 3└── intro             # Chapter folder
 4    ├── _index.md     # Chapter metadata including chapter title
 5    ├── example1.md   # A page
 6    └── example2.md   # Another page
 7└── tutorial          # Another chapter
 8    ├── _index.md
 9    ├── intro.md
10    └── ...

• В именах файлов и папок вместо пробелов следует использовать дефисы.
• Папка course может быть переименована.
• Например, мы можем переименовать её в book для написания книги, docs для документации по программному обеспечению/проекту, notes для создания блокнота или tutorials для создания многостраничных руководств.

3 Метаданные

• Рассмотрим структуру файла _index.md (например content/course/example/_index.md) для книги.
• Укажем название и краткое содержание книги.

   1# Page title
   2title: An Example Course
   3
   4# Title for the menu link if you wish to use a shorter link title, otherwise remove this option.
   5linktitle: Course
   6
   7# Page summary for search engines.
   8summary: Blah, blah, blah...
   9
  10# Date page published
  11date: 2018-09-09
  12
  13# Book page type (do not modify).
  14type: book
  15
  16# Position of this page in the menu. Remove this option to sort alphabetically.
  17weight: 1
  

4 Меню

• Можете задать меню тремя способами:
  • по возрастанию названия;
  • по убыванию названия;
  • путём ручного упорядочивания с использованием weight: 10 для первых страниц, где номер определяет порядок.
  • Рекомендуется использовать веса с шагом 10, чтобы в будущем можно было легко изменить порядок страниц без необходимости изменять вес всех других страниц.

5 Страницы

• Вы можете создать столько страниц, сколько вам нужно. Каждая страница должна иметь поле title и тип type: book.
  • title : заголовок страницы (отображается в заголовке страницы);
  • linktitle : метка для ссылки на эту страницу (отображается в меню). Если удалить linktitle, ссылка меню не будет отображать заголовок страницы.
• Чтобы удалить правую боковую панель для оглавления страницы (сгенерированного из заголовков на вашей странице), установите toc: false.
• Чтобы отображать предыдущий/следующий пейджер внизу каждой страницы раздела документов, включите docs_section_pager в params.yaml, затем установите порядок пейджера, определив weight для каждой страницы.
• Пример страницы выглядит следующим образом:

  1---
  2title: Example Page 1
  3date: 2019-05-05
  4type: book
  5---
  6
  7Content...
  

• Чтобы перечислить дочерние страницы на страницах глав книги, можно использовать сокращение .