Skip to content

Commit 201a5eb

Browse files
chore(skills): document VitePress {{ }} v-pre gotcha in documentation-workflow (#846)
1 parent fd5af26 commit 201a5eb

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

  • .agents/skills/documentation-workflow

.agents/skills/documentation-workflow/SKILL.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ description: Use when adding or updating massCode documentation, documenting a n
3131
- Пиши короткими task-oriented секциями. Предпочитай пользовательские флоу, а не детали реализации.
3232
- Shortcuts документируй через `<kbd>...</kbd>` и указывай macOS плюс Windows/Linux варианты, если они отличаются.
3333

34+
## VitePress Markdown Gotchas
35+
36+
- VitePress компилирует markdown как Vue-компонент, поэтому `{{ ... }}` трактуется как Vue-интерполяция и **исчезает** из вывода.
37+
- Fenced-блоки (` ``` `) защищены автоматически — внутри них `{{var}}` рендерится буквально.
38+
- **Инлайн-код в backticks НЕ защищён**: `` `{{variables}}` `` отрендерится пустым. Чтобы вывести литеральные двойные фигурные скобки в тексте или таблице, оборачивай в `v-pre`:
39+
`<code v-pre>{{variables}}</code>`
40+
- Это же касается любых других Vue-конструкций (`{{ }}`, директивы) в произвольном тексте страницы.
41+
3442
## Images And Assets Rules
3543

3644
- Картинки для docs клади в `docs/website/public`.
@@ -61,3 +69,4 @@ description: Use when adding or updating massCode documentation, documenting a n
6169
- Добавлять version availability в README.
6270
- Документировать shortcuts или поведение без проверки реализации.
6371
- Запускать широкие formatters, которые переписывают существующий стиль docs config.
72+
- Писать литеральные `{{ ... }}` в инлайн-коде без `v-pre` — VitePress съест их как Vue-интерполяцию.

0 commit comments

Comments
 (0)