DOCSUP-119857: Доработать статью о PDF #223
Conversation
✅ Documentation buildRevision built successfully |
✅ Documentation buildRevision built successfully |
✅ Documentation buildRevision built successfully |
ru/guides/generate-pdf.md
Outdated
|
|
||
| ## Стилизация PDF | ||
|
|
||
| Вы можете изменить внешний вид PDF-документа с помощью [кастомных CSS-стилей](../style/css-js.md). |
There was a problem hiding this comment.
"кастомных" нужно или убрать или заменить - жаргон
ru/guides/generate-pdf.md
Outdated
| @@ -0,0 +1,110 @@ | |||
| # Создание PDF из документации | |||
|
|
|||
| Diplodoc может генерировать документацию в формате PDF. Это полезно, когда нужно подготовить материалы для Open Source проекта или проверить верстку перед публикацией. | |||
There was a problem hiding this comment.
Предложение про то, зачем полезно генерить PDF, можно убрать: тому, кто ищет эту информацию, это и так понятно.
ru/guides/generate-pdf.md
Outdated
|
|
||
| {% note info %} | ||
|
|
||
| Для каждого файла `toc.yaml` Diplodoc создает отдельный `single-page.pdf`. Страница в PDF располагаются в том же порядке, что и в оглавлении. |
There was a problem hiding this comment.
"Страницы" -> "Статьи располагаются в том же порядке..."
ru/guides/generate-pdf.md
Outdated
|
|
||
| PDF-документ состоит из трех частей: | ||
|
|
||
| 1. **Титульная страница** |
ru/guides/generate-pdf.md
Outdated
| - path-to-page-n.md | ||
| ``` | ||
|
|
||
| Эти страницы не дублируются в основном оглавлении и отображаются в начале PDF. |
There was a problem hiding this comment.
тут всё как-то не так: страницы внутри pdf идут перед оглавлением и не добавляются в него;
"дублируется" - неподходящая формулировка, как кажется;
"отображается" - тоже не лучшее слово для определения того, где страницы размещены внутри pdf
|
|
||
| - блоки Page Constructor; | ||
| - перекрестные ссылки; | ||
| - изображения и другие медиа-файлы. |
There was a problem hiding this comment.
также, можно добавить, что каждая следующая статья внутри PDF идёт с новой страницы
ru/guides/generate-pdf.md
Outdated
|
|
||
| {% list tabs %} | ||
|
|
||
| - Локальная сборка |
There was a problem hiding this comment.
с точки зрения пользователя, любая сборка будет локальной — лучше переформулировать под включение сборки через параметр запуска и через настройку .yfm ; возможно, вообще убрать табы в этом месте
✅ Documentation buildRevision built successfully |
✅ Documentation buildRevision built successfully |
✅ Documentation buildRevision built successfully |
No description provided.