content-rules

Правила заметок, ссылок и картинок

Publish flag

Заметка публикуется только если у неё есть:

dg-publish: true

или:

dgPublish: true

Если этого нет, engine не будет собирать заметку.

Главная страница

Главную страницу лучше помечать так:

dg-home: true

или так:

tags:
  - gardenEntry

Не надо заставлять сотрудников писать:

dg-permalink: /

Для обычных заметок permalink не обязателен.

Если нужен ручной URL:

permalink: /my-page/

Также поддерживаются:

dg-permalink: /my-page/
dgPermalink: /my-page/

Если permalink не задан, URL строится из пути файла.

Можно писать как в Obsidian:

Другая заметка

С alias:

читать дальше

С heading:

Другая заметка

Чтобы ссылка не вела на /404, целевая заметка должна быть опубликована.

Engine ищет цель по:

имени файла
basename без .md
относительному пути
title
первому H1
permalink

Backlinks строятся по wikilinks ....

Обычная markdown-ссылка:

[читать](/some-page/)

может вести на страницу, но не всегда даёт такую же связь в graph/backlinks.

Картинки

В markdown лучше ссылаться на публичный путь:

![Описание](/img/user/foto/example.jpg)

Исходный файл может лежать в vault:

<slug>-vault/foto/example.jpg

Во время build engine перенесёт его в:

dist/img/user/foto/example.jpg

Debug:

DUCK_DEBUG_IMAGES=1 npm run build

Callouts, Mermaid, PlantUML, MathJax

Engine поддерживает Obsidian-style callouts, Mermaid, PlantUML, MathJax и task checkboxes.

Пример Mermaid:

```mermaid
graph TD
  A --> B
```

Пример PlantUML:

```plantuml
Alice -> Bob: Hello
```

Что не редактировать руками

Не редактировать:

dist/
.duck-garden/
node_modules/

Это build artifacts. Они пересоздаются.

Контент должен жить в:

<slug>-vault/
src/site/notes/
src/site/img/user/