Skip to content

Commit 89ef981

Browse files
committed
edit docs/content.md
1 parent cb90349 commit 89ef981

2 files changed

Lines changed: 10 additions & 21 deletions

File tree

ru/tools/docs/build.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,13 @@ yfm -o ./output-folder
2626
* [проверки условия отображения контента](../../syntax/vars.md#conditions) на страницах документа;
2727
* [подстановки переменных](../../syntax/vars.md#subtitudes), если указан параметр `apply-presets`;
2828
* [инлайнинг SVG-изображений](../../syntax/media.md#img-inline);
29-
* [подстановки заголовков статей вместо {#T}](../../syntax/links.md#autotitle).
29+
* [подстановки заголовков статей вместо {#T}](../../syntax/links.md#autotitle);
30+
* [вставки контента из файлов](../../syntax/includes.md).
3031

3132
Используйте этот вид сборки, чтобы поддерживать несколько вариантов документации для разных пользователей. Если в документации есть разделы с внутренней информацией, вы можете держать два репозитория — приватный и публичный, и синхронизировать приватный в публичный с помощью условий.
3233

3334
## Watch-режим {#watch}
3435

35-
{% note info "Beta-функциональность" %}
36-
37-
При возникновении проблем сообщите об этом с помощью [GitHub issues](https://github.com/diplodoc-platform/cli/issues).
38-
39-
{% endnote %}
40-
4136
Вы можете автоматизировать пересборку отдельных статей при их изменении. Для этого вызовите `yfm build` с параметром `--watch`: после сборки проекта программа перейдёт в режим инкрементальной пересборки и будет создавать или обновлять статьи после сохранения изменений в исходных файлах документации.
4237

4338
Для удобства, после пересборки открытого в браузере файла выполняется автоматическая перезагрузка страницы.

ru/tools/docs/content.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Сборка одного файла
22

3-
Команда `yfm content` обрабатывает **один** Markdown-файл и выводит результат в `stdout` (или записывает в файл). В отличие от [`yfm build`](build.md), она не обходит весь проект и не собирает полноценную страницу: для формата `html` выводится только **контентный фрагмент** — без оглавления, шапки и прочей обвязки страницы.
3+
Команда `yfm content` обрабатывает **один** md-файл и выводит результат в `stdout` (или записывает в файл). В отличие от [`yfm build`](build.md), она не собирает полноценную страницу: для формата `html` выводится только **контент** — без оглавления, шапки и обвязки страницы.
44

55
Команда удобна, когда нужно быстро получить предобработанный контент одного файла — например, чтобы передать его в другой инструмент, отрендерить предпросмотр в редакторе или использовать в собственном пайплайне.
66

@@ -20,21 +20,21 @@ yfm content -i ./page.md -f html -o ./page.html
2020

2121
Формат задаётся параметром `--output-format` (`-f`):
2222

23-
* `md`self-contained Markdown: [вставки](../../project/toc-includes.md) и [автозаголовки](../../syntax/links.md#autotitle) встроены в файл, добавлен frontmatter. По умолчанию для одиночного файла.
24-
* `html`только контентный HTML-фрагмент страницы (без оглавления, шапки и обвязки).
23+
* `md`предобработанный Markdown. По умолчанию для одиночного файла.
24+
* `html` — HTML-контент страницы (без оглавления, шапки и обвязки).
2525

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).
2727

2828
## Корень проекта {#project-root}
2929

30-
Пресеты (`presets.yaml`), [вставки](../../syntax/includes.md), ссылки и [переменные](../../syntax/vars.md) резолвятся относительно корня проекта:
30+
Пресеты (`presets.yaml`), [вставки](../../syntax/includes.md), ссылки и [переменные](../../syntax/vars.md) ищутся относительно корня проекта:
3131

3232
* по умолчанию корнем считается **текущая рабочая директория**;
3333
* передайте `--config` (`-c`) с путём до `.yfm` — корнем станет директория этого файла.
3434

3535
{% note info %}
3636

37-
Если обрабатываемый файл лежит вне выбранного корня, корнем становится директория самого файла — чтобы вставки и пресеты корректно резолвились.
37+
Если обрабатываемый файл лежит вне выбранного корня, корнем становится директория самого файла.
3838

3939
{% endnote %}
4040

@@ -60,25 +60,19 @@ yfm content -i ./page.md -f html -o ./page.html
6060
yfm content -i ./page.md -f md --raw > page.md
6161
```
6262

63-
При этом диагностика (предупреждения, ошибки) по-прежнему идёт в `stderr`, а код возврата остаётся ненулевым при ошибке — так что `stdout` содержит только валидный контент.
63+
При этом диагностика (предупреждения, ошибки) по-прежнему идёт в `stderr`, а код возврата остаётся ненулевым при ошибке — так что `stdout` содержит только корректный контент.
6464

6565
Вместе с `-o` флаг `--raw` ничего не меняет: в файл всегда пишется «сырой» контент.
6666

6767
## Watch-режим {#watch}
6868

69-
{% note info "Beta-функциональность" %}
70-
71-
При возникновении проблем сообщите об этом с помощью [GitHub issues](https://github.com/diplodoc-platform/cli/issues).
72-
73-
{% endnote %}
74-
7569
С параметром `--watch` (`-w`) команда отслеживает изменения входного файла, его вставок и пресетов и перерисовывает результат при каждом сохранении.
7670

7771
## Параметры {#options}
7872

7973
| Параметр | По умолчанию | Описание |
8074
| ----------------------------------- | ------------ | -------------------------------------------------------------- |
81-
| `-i, --input <file>` || Путь до обрабатываемого Markdown-файла (обязательный) |
75+
| `-i, --input <file>` || Путь до обрабатываемого md-файла (обязательный) |
8276
| `-o, --output <file>` | stdout | Записать результат в файл вместо stdout |
8377
| `-f, --output-format <md \| html>` | `html` | Формат вывода |
8478
| `--raw` | `false` | Выводить в stdout только контент (без маркеров и баннеров) |

0 commit comments

Comments
 (0)