potyk.io
🔒

Markdown-страницы

Страницы сайта, собранные из .md: открыл URL — видишь HTML-версию заметки. В начале файла может быть блок свойств (frontmatter) между двумя строками ---; сам блок на странице не показывается. Ширина колонки для таких страниц — обычно m (~800px), см. main-width.

Зачем

Чтобы писать заметки обычным markdown’ом и управлять оформлением страницы и карточек в лентах через несколько явных свойств, без правки шаблонов.

Сценарии

Открыть страницу

Пользователь открывает адрес заметки. На странице:

  1. Заголовок — первый # … в теле (если его нет, берётся имя файла).
  2. Под заголовком — дата, если задана в свойствах (created).
  3. Дальше — оглавление, если включено (toc) и есть подходящие заголовки.
  4. Затем тело заметки: текст, списки, ссылки, картинки и т.п. Вложенные списки с отступом в два пробела (как в Obsidian) сохраняют уровни.

Шапка сайта по умолчанию на месте; её можно выключить свойством header.

Дата (created)

Зачем: показать, когда заметка «опубликована», только когда автор это явно указал.

В frontmatter стоит created: ГГГГ-ММ-ДД. Под заголовком появляется дата по-русски. Без created дата на странице не показывается.

Оглавление (toc)

Зачем: длинные заметки удобно листать по разделам, не собирая список ссылок вручную.

В frontmatter задан toc. После заголовка (и даты, если она есть) появляется оглавление — ссылки на подходящие заголовки в порядке появления; клик переносит к разделу.

  • toc: true (или yes / 1 / on) — заголовки h2–h4, с вложенностью по уровню.
  • toc: h2 — только заголовки h2, без вложенных пунктов.

toc нет, выключен (false / no / 0 / off) или нет подходящих заголовков — оглавление не показывается.

Шапка сайта (header)

В frontmatter header: false (или другое явное «нет») — страница без обычной шапки сайта. Иначе шапка есть.

Картинка в теле заметки

Зачем: показать фото/скрин в нужном месте текста.

В теле — обычная markdown-картинка: ![подпись](адрес). Адрес — путь к файлу на сайте (часто /static/…) или внешняя ссылка. Картинка появляется в месте вставки и занимает ширину колонки текста.

Картинка из свойств frontmatter в тело страницы сама не подставляется.

Обложка для ленты (cover)

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

В frontmatter — cover: и адрес файла. В лентах у карточки этой страницы показывается эта обложка:

  • обычная картинка (.jpg, .png, …) — как картинка;
  • видео (.mp4, .webm, .mov, …) — как короткое превью-видео (без звука, зациклено).

Тип выбирается по расширению в адресе, отдельного свойства не нужно. На самой открытой странице cover ничего не добавляет (если нужно медиа в тексте — вставь его в тело: картинку markdown’ом, видео — тегом <video>).

Превью для ленты (preview / description)

Зачем: в карточке ленты короткий осмысленный текст вместо обрезанного куска тела.

В frontmatter задан preview: (или description:). В карточке ленты — заголовок страницы и этот текст. Если ни того ни другого нет — превью строится из начала тела заметки.