You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[подстановки заголовков статей вместо {#T}](../../syntax/links.md#autotitle).
29
+
*[подстановки заголовков статей вместо {#T}](../../syntax/links.md#autotitle);
30
+
*[вставки контента из файлов](../../syntax/includes.md).
30
31
31
32
Используйте этот вид сборки, чтобы поддерживать несколько вариантов документации для разных пользователей. Если в документации есть разделы с внутренней информацией, вы можете держать два репозитория — приватный и публичный, и синхронизировать приватный в публичный с помощью условий.
32
33
33
34
## Watch-режим {#watch}
34
35
35
-
{% note info "Beta-функциональность" %}
36
-
37
-
При возникновении проблем сообщите об этом с помощью [GitHub issues](https://github.com/diplodoc-platform/cli/issues).
38
-
39
-
{% endnote %}
40
-
41
36
Вы можете автоматизировать пересборку отдельных статей при их изменении. Для этого вызовите `yfm build` с параметром `--watch`: после сборки проекта программа перейдёт в режим инкрементальной пересборки и будет создавать или обновлять статьи после сохранения изменений в исходных файлах документации.
42
37
43
38
Для удобства, после пересборки открытого в браузере файла выполняется автоматическая перезагрузка страницы.
Copy file name to clipboardExpand all lines: ru/tools/docs/content.md
+8-14Lines changed: 8 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Сборка одного файла
2
2
3
-
Команда `yfm content` обрабатывает **один**Markdown-файл и выводит результат в `stdout` (или записывает в файл). В отличие от [`yfm build`](build.md), она не обходит весь проект и не собирает полноценную страницу: для формата `html` выводится только **контентный фрагмент** — без оглавления, шапки и прочей обвязки страницы.
3
+
Команда `yfm content` обрабатывает **один**md-файл и выводит результат в `stdout` (или записывает в файл). В отличие от [`yfm build`](build.md), она не собирает полноценную страницу: для формата `html` выводится только **контент** — без оглавления, шапки и обвязки страницы.
4
4
5
5
Команда удобна, когда нужно быстро получить предобработанный контент одного файла — например, чтобы передать его в другой инструмент, отрендерить предпросмотр в редакторе или использовать в собственном пайплайне.
*`md` — self-contained Markdown: [вставки](../../project/toc-includes.md) и [автозаголовки](../../syntax/links.md#autotitle) встроены в файл, добавлен frontmatter. По умолчанию для одиночного файла.
24
-
*`html` — только контентный HTML-фрагмент страницы (без оглавления, шапки и обвязки).
23
+
*`md` — предобработанный Markdown. По умолчанию для одиночного файла.
24
+
*`html` — HTML-контент страницы (без оглавления, шапки и обвязки).
25
25
26
-
При обработке применяются те же преобразования, что и при [сборке YFM → YFM](build.md#yfm): проверки условий видимости, [подстановки переменных](../../syntax/vars.md#subtitudes), инлайнинг SVG и подстановки заголовков.
26
+
При обработке применяются те же преобразования, что и при [сборке YFM → YFM](build.md#yfm): проверка условий видимости, [подстановка переменных](../../syntax/vars.md#subtitudes), [инлайнинг SVG](../../syntax/media.md#img-inline), [вставка заголовков](../../syntax/links.md#autotitle) и [контента из файлов](../../syntax/includes.md).
27
27
28
28
## Корень проекта {#project-root}
29
29
30
-
Пресеты (`presets.yaml`), [вставки](../../syntax/includes.md), ссылки и [переменные](../../syntax/vars.md)резолвятся относительно корня проекта:
30
+
Пресеты (`presets.yaml`), [вставки](../../syntax/includes.md), ссылки и [переменные](../../syntax/vars.md)ищутся относительно корня проекта:
31
31
32
32
* по умолчанию корнем считается **текущая рабочая директория**;
33
33
* передайте `--config` (`-c`) с путём до `.yfm` — корнем станет директория этого файла.
34
34
35
35
{% note info %}
36
36
37
-
Если обрабатываемый файл лежит вне выбранного корня, корнем становится директория самого файла — чтобы вставки и пресеты корректно резолвились.
37
+
Если обрабатываемый файл лежит вне выбранного корня, корнем становится директория самого файла.
При этом диагностика (предупреждения, ошибки) по-прежнему идёт в `stderr`, а код возврата остаётся ненулевым при ошибке — так что `stdout` содержит только валидный контент.
63
+
При этом диагностика (предупреждения, ошибки) по-прежнему идёт в `stderr`, а код возврата остаётся ненулевым при ошибке — так что `stdout` содержит только корректный контент.
64
64
65
65
Вместе с `-o` флаг `--raw` ничего не меняет: в файл всегда пишется «сырой» контент.
66
66
67
67
## Watch-режим {#watch}
68
68
69
-
{% note info "Beta-функциональность" %}
70
-
71
-
При возникновении проблем сообщите об этом с помощью [GitHub issues](https://github.com/diplodoc-platform/cli/issues).
72
-
73
-
{% endnote %}
74
-
75
69
С параметром `--watch` (`-w`) команда отслеживает изменения входного файла, его вставок и пресетов и перерисовывает результат при каждом сохранении.
0 commit comments