Skip to content

Commit b1d6b9d

Browse files
authored
Merge pull request #227 from bloodmike/update/pdf-extra-links
add pdf generation info
2 parents 826ae4d + 51c2480 commit b1d6b9d

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

ru/guides/generate-pdf.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ PDF-документ состоит из трех частей:
88

99
1. **Титульные страницы** {#start-pages}
1010

11-
Чтобы сформировать титульные страницы, настройте блок `startPages` в `toc.yaml`:
11+
Отображаются в начале документации и не нумеруются.
12+
13+
Титульные страницы указываются в блоке `startPages` в `toc.yaml`:
1214

1315
```yaml
1416
pdf:
@@ -24,7 +26,7 @@ PDF-документ состоит из трех частей:
2426

2527
{% endnote %}
2628

27-
Чтобы проверить верстку в браузере, используйте флаг `--pdf-debug`. Он создаст HTML-версии страниц из `startPages`.
29+
При сборке документации титульные страницы не трансформируются в файлы. Для проверки их верстки в браузере, используйте при сборке флаг `--pdf-debug`: он создаст HTML-версии страниц из `startPages`.
2830

2931
1. **Оглавление**
3032

@@ -41,7 +43,7 @@ PDF-документ состоит из трех частей:
4143
- перекрестные ссылки;
4244
- изображения и другие медиа-файлы.
4345

44-
Каждая следующая статья PDF-документа начинается с новой страницы.
46+
Каждая следующая статья PDF-документа начинается с новой страницы. Статьи в PDF располагаются в том же порядке, что и в оглавлении.
4547

4648
## Сборка { #build }
4749

@@ -67,7 +69,8 @@ PDF-документ состоит из трех частей:
6769
```
6870

6971
- `-i .` — путь к папке с исходниками (в примере — текущая папка);
70-
- `-o ./docs-output` — путь к папке для результатов сборки.
72+
- `-o ./docs-output` — путь к папке для результатов сборки;
73+
- `--pdf` — флаг, включающий подготовку данных для генерации PDF; если поддержка PDF включена в `.yfm`, флаг передавать не требуется.
7174

7275
1. Запустите генератор PDF:
7376

@@ -77,7 +80,7 @@ PDF-документ состоит из трех частей:
7780

7881
{% note info %}
7982

80-
Для каждого файла `toc.yaml` Diplodoc создает отдельный `single-page.pdf`. Статьи в PDF располагаются в том же порядке, что и в оглавлении.
83+
Для каждого файла `toc.yaml` Diplodoc создает отдельный `single-page.pdf`.
8184

8285
{% endnote %}
8386

ru/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ extensions:
240240

241241
### Секция `pdf` {#pdf}
242242

243-
Для генерации pdf-версии документации необходимо использовать сервис `@diplodoc/pdf-generator` [согласно инструкции](https://github.com/diplodoc-platform/pdf-generator). Секция содержит параметры предобработки данных для работы сервиса.
243+
Содержит параметры предобработки данных для [генерации pdf-версии](guides/generate-pdf.md) документации.
244244

245245
#|
246246
|| **Название** | **Описание** | **Тип и значение по умолчанию** ||

0 commit comments

Comments
 (0)