Шаблоны: API

Методы

Пример

<article>
  <h1>{{ note.Title() }}</h1>
  <time>{{ note.CreatedAt().Format("02.01.2006") }}</time>
  <span>{{ note.ReadingTime() }} мин</span>

  {{ note.HTMLString() }}
</article>

Методы доступа

Все методы возвращают nil, если заметки нет. Работают и {{ if x }}, и {{ if x == nil }}, а x.Title() на nil останавливает рендер. Удобнее объявить и проверить в одном теге: {{ if about := nvs.ByPermalink("/about"); about }}…{{ end }}.

Методы для навигации

Методы запросов

Примеры

{* Загрузить заметку по пути *}
{{ sidebar := nvs.ByPath("/docs/_sidebar.md") }}
{{ if sidebar }}
  {{ sidebar.HTMLString() }}
{{ end }}

{* Загрузить по URL *}
{{ about := nvs.ByPermalink("/about") }}

{* Обратные ссылки *}
{{ range i, link := nvs.BackLinks(note) }}
  <a href="{{ link.Permalink() }}">{{ link.Title() }}</a>
{{ end }}

Фильтрация

nvs.ByGlob("blog/*.md")           {* Все .md в папке blog *}
nvs.ByGlob("docs/**/*.md")        {* Рекурсивно все .md в docs *}
nvs.ByGlob("projects/**/README.md") {* Все README.md *}
nvs.Query()                        {* Все заметки без фильтра *}

Паттерн сравнивается с путём файла без ведущего слэша: "blog/*.md" работает, "/blog/*.md" не находит ничего.

Поддерживаемые glob-паттерны:

• * — любые символы кроме /
• ** — любая вложенность
• ? — один символ

Что попадает в выборку

Всё, что подходит под паттерн: платные заметки, заметки за входом и системные (_) тоже. Для публичной страницы добавьте .Public():

{* только то, что может прочитать анонимный посетитель *}
nvs.ByGlob("blog/*.md").Public()

.Public() оставляет заметки с free (в том числе в подграфе со входом), не системные и без noindex. Фильтр срабатывает до Offset и Limit.

Сортировка

.SortBy("Title")       {* По заголовку *}
.SortBy("CreatedAt")   {* По дате создания *}
.SortBy("Permalink")   {* По URL *}
.SortBy("created_at")  {* snake_case тоже работает *}

.SortByMeta("order")   {* По полю frontmatter *}
.SortByMeta("weight")

• SortBy принимает любой метод Note без аргументов: Title, CreatedAt, Permalink, PathID, ReadingTime, UpdatedAt, Author… Неизвестное имя порядок не меняет, ошибки не будет.
• SortByMeta сравнивает строки, целые и дробные числа, время. Заметки без значения идут первыми (с Desc() — последними). Значения разных типов, например 1 и 1.5, считаются равными.
• Даты в frontmatter без кавычек (date: 2024-05-10) приходят строками. Даты в формате ISO как строки сортируются правильно.
• Без сортировки порядок случайный и меняется между рендерами. Сортировка стабильная, но равные элементы сохраняют этот случайный порядок, поэтому добавляйте второй критерий: .SortByMeta("date").Desc().SortBy("Title").

Направление

.Desc()   {* Последний критерий — по убыванию *}
.Asc()    {* Последний критерий — по возрастанию (по умолчанию) *}

Множественная сортировка

{* Сначала по категории, внутри — по заголовку *}
nvs.ByGlob("blog/*.md").SortByMeta("category").SortBy("Title")

Пагинация

.Limit(10)              {* Первые 10 *}
.Offset(5)              {* Пропустить 5 *}
.Offset(10).Limit(10)   {* Вторая страница *}

Limit(0) — без ограничения. Offset дальше конца даёт пустой список.

Терминальные методы

All() выборку не меняет, её можно выполнить ещё раз. First() навсегда ставит выборке лимит 1 — после него ту же выборку не используйте.

Полный пример

{* Последние 5 публичных постов блога *}
{{ blog := nvs.ByGlob("blog/*.md").Public() }}
{{ posts := blog.SortBy("CreatedAt").Desc().Limit(5).All() }}
{{ range i, post := posts }}
  <a href="{{ post.Permalink() }}">{{ post.Title() }}</a>
{{ end }}

{* Документация с ручным порядком *}
{{ range i, doc := nvs.ByGlob("docs/*.md").SortByMeta("order").All() }}
  <a href="{{ doc.Permalink() }}">{{ doc.Title() }}</a>
{{ end }}

{* Последний пост *}
{{ latest := nvs.ByGlob("blog/*.md").SortBy("CreatedAt").Desc().First() }}
{{ if latest }}
  <a href="{{ latest.Permalink() }}">{{ latest.Title() }}</a>
{{ end }}

Методы

Приведение типов

GetBool понимает:

• true, false (bool)
• "true", "yes", "1" (string → true); любая другая строка — false
• 1, 0 (число → bool: не ноль — true)

GetInt понимает:

• int, int64, float64 (дробная часть отбрасывается: 2.7 → 2). Строка "3" даёт default

Примеры

{* Проверка наличия *}
{{ if note.M().Has("featured") }}
  <span class="badge">Featured</span>
{{ end }}

{* Получение значений *}
{{ author := note.M().GetString("author", "Anonymous") }}
{{ order := note.M().GetInt("order", 999) }}
{{ published := note.M().GetBool("published", false) }}

{* Теги *}
{{ range i, tag := note.M().GetStrings("tags") }}
  <span class="tag">{{ tag }}</span>
{{ end }}

Методы

Подробнее с примерами — в Шаблонах.

Структуры

type Section struct {
    ID          string  // Якорь заголовка, тот же, что в TOC() и в HTML
    Level       int     // Уровень заголовка: 2 для ##
    Title       string  // Текст заголовка без разметки
    TitleHTML   string  // Текст заголовка (без тега)
    ContentHTML string  // Контент до следующего заголовка не ниже уровнем
}

type ListItem struct {
    Text     string
    URL      string
    Task     string  // "", "todo" для [ ], "done" для любого другого символа
    TaskMark string  // Символ в скобках: " ", "x", "/"…; "" без чекбокса
    Children []ListItem
}

type Image struct {
    URL   string  // Адрес, по которому картинку отдаёт страница
    Alt   string
    Title string
}

type CodeBlock struct {
    Lang    string  // Первое слово после ```
    Info    string  // Вся строка после ```
    Content string  // Код как написан
    HTML    string  // Блок как его рендерит страница
}

У секции есть свои Sections(level) и Section(title) — для вложенных подсекций.

Примеры

{* Вступление *}
{{ intro := note.PartialRenderer().Introduce() }}
<div class="lead">{{ intro.ContentHTML }}</div>

{* FAQ из H3 *}
{{ range i, q := note.PartialRenderer().Sections(3) }}
  <details>
    <summary>{{ q.TitleHTML }}</summary>
    <div>{{ q.ContentHTML }}</div>
  </details>
{{ end }}

{* Конкретная секция *}
{{ faq := note.PartialRenderer().Section("FAQ") }}
{{ if faq }}
  {{ faq.ContentHTML }}
{{ end }}

Переменные

{{ x := "value" }}              {* Объявление *}
{{ x = "new value" }}           {* Присваивание *}
{{ x }}                         {* Вывод *}

Условия

{{ if condition }}
  ...
{{ else if other }}
  ...
{{ else }}
  ...
{{ end }}

Циклы

{* range возвращает индекс и значение *}
{{ range i, item := list }}
  {{ i }}: {{ item }}
{{ end }}

{* Только значение — НЕПРАВИЛЬНО, item будет индексом! *}
{{ range item := list }}  {* item = 0, 1, 2... *}

{* Индекс не нужен — _ вместо первой переменной *}
{{ range _, item := list }}
  {{ item }}
{{ end }}

exec/return (данные из другого файла) и try/catch (заглушка вместо упавшего виджета) — в документации Jet.

Блоки и наследование

{* blocks.html *}
{{ block header() }}
  <header>Default header</header>
{{ end }}

{* page.html *}
{{ import "blocks" }}

{{ yield header() }}  {* Вызов блока *}

Наследование

Базовый шаблон отмечает места блоками с содержимым по умолчанию, страница начинается с {{ extends "base" }} и переопределяет нужные блоки. Как это устроено, с проверенным примером, — в Шаблонах: наследование.

Фильтры

{{ value }}                   {* Экранируется по умолчанию *}
{{ value | unsafe }}          {* Вывод строки без экранирования *}

Вывод экранируется. Методы, которые возвращают готовый HTML (HTMLString(), TitleHTML, ContentHTML, FirstListHTML(), FormSpecJSON(), asset()), имеют тип model.SafeHTML и выводятся как есть. | html экранирует один раз и тоже возвращает SafeHTML, поэтому старые шаблоны с | html не экранируют дважды.

Разбор данных

{{ d := parseJSON(text) }}    {* JSON в словари и списки, nil при ошибке *}
{{ d := parseYAML(text) }}    {* То же для YAML *}
{{ rows := parseCSV(text) }}  {* Список строк, строка — список значений *}

Подробнее — в разделе Разбор данных. Все функции и фильтры — в Справочнике функций Jet.