Skip to content

Метаданные файла

Dmitry Sedykh edited this page Dec 7, 2019 · 3 revisions

Кроме текста файл может содержать дополнительную метаинформацию в заголовке.

---
title: Лис и бубен
---
Решил лис шаманом стать. Между мирами ходить, с духами разговаривать,
злых существ заклинать, у добрых помощи просить. Сил нет, как захотел.
А какой шаман без бубна? Никакой.

В качестве метаинформации вы можете использовать ЛЮБЫЕ поля. Т.е. можете определять свою метаинформацию о файле и добавлять ее в заголовок — это никак не скажется на работоспособности компилятора.

Ниже перечислены те поля, которые используются компилятором и могут как-то влиять на публикацию.

title

title является обязательным элементом метаинформации. Если он не указан, то будет автоматически использована строка "* * *". Соответственно, в оглавлении тоже появятся три "звездочки" для этого файла. Возможно, что это и не совсем правильно, но мне показалось, что это удобнее, чем выводить ошибку по этому поводу. Тем более, что это позволяет вообще не использовать метаинформацию в файле.

lang

Здесь вы можете указать язык содержимого страницы. Если не указано, то используется язык публикации.

properties

Специальные свойства, описывающие тип содержимого. На сегодняшний момент поддерживаются следующие значения:

  • nav — содержимое является оглавлением публикации

hidden

Если значение этого поля указано как true, yes или ok, то данный файл будет включен в публикацию, но исключен из нормального порядка листания: т.е. его содержимое будет доступно только по ссылке из другого файла.

class

Здесь вы можете указать любую строку — она станет именем класса элемента HTML body. Таким образом вы можете влиять на стилевое оформление отдельных страниц.