Hugo. Wowchemy. Book

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

Содержание

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

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

2 Структура

  • Предлагается использовать следующую файловую структуру:
content/course
├── _index.md         # Overview
└── intro             # Chapter folder
    ├── _index.md     # Chapter metadata including chapter title
    ├── example1.md   # A page
    └── example2.md   # Another page
└── tutorial          # Another chapter
    ├── _index.md
    ├── intro.md
    └── ...
  • В именах файлов и папок вместо пробелов следует использовать дефисы.
  • Папка course может быть переименована.
  • Например, мы можем переименовать её в book для написания книги, docs для документации по программному обеспечению/проекту, notes для создания блокнота или tutorials для создания многостраничных руководств.

3 Метаданные

  • Рассмотрим структуру файла _index.md (например content/course/example/_index.md) для книги.
  • Укажем название и краткое содержание книги.
    # Page title
    title: An Example Course
    
    # Title for the menu link if you wish to use a shorter link title, otherwise remove this option.
    linktitle: Course
    
    # Page summary for search engines.
    summary: Blah, blah, blah...
    
    # Date page published
    date: 2018-09-09
    
    # Book page type (do not modify).
    type: book
    
    # Position of this page in the menu. Remove this option to sort alphabetically.
    weight: 1
    

4 Меню

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

5 Страницы

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

Дмитрий Сергеевич Кулябов
Дмитрий Сергеевич Кулябов
Профессор кафедры теории вероятностей и кибербезопасности

Мои научные интересы включают физику, администрирование Unix и сетей.

Похожие