Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ru/guides/generate-pdf.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Инструкция
---
# Создание PDF из документации

Diplodoc может генерировать документацию в формате PDF.
Expand Down
5 changes: 5 additions & 0 deletions ru/guides/multilingual-projects.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
tags:
- Структура
- Локализация
---
# Многоязычные проекты

Если ваша документация переведена на несколько языков, вы можете управлять ею с помощью многоязычного проекта. Такой проект поддерживает несколько версий контента — по одной на каждый язык. Локализованные версии хранятся в одном репозитории и попадают в общую сборку.
Expand Down
4 changes: 4 additions & 0 deletions ru/guides/pdf-styles.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Стизилизация
---
# Пользовательские стили в PDF

[PDF-версия документации](generate-pdf.md) собирается в три шага:
Expand Down
2 changes: 1 addition & 1 deletion ru/guides/source-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

{% note alert %}

sourcedocs-инклюдер находится в процессе деприкации в пользу [generic-инклюдера](generic.md).
sourcedocs-инклюдер находится в процессе отключения в пользу [generic-инклюдера](generic.md).

{% endnote %}

Expand Down
4 changes: 4 additions & 0 deletions ru/project/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Структура
---
# Структура проекта

Базовый проект включает [файл оглавления](./toc.md) и файлы с контентом.
Expand Down
4 changes: 4 additions & 0 deletions ru/project/navigation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Стилизация
---
# Расширенная навигация

Платформа поддерживает гибкую настройку верхней и нижней навигации («шапки» и «подвала») на странице.
Expand Down
4 changes: 4 additions & 0 deletions ru/project/toc-multiple.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Структура
---
# Несколько оглавлений

Можно разделить проект документации на части, сгруппировав статьи в несколько оглавлений и связав их перекрестными ссылками.
Expand Down
4 changes: 4 additions & 0 deletions ru/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Инструкция
---
# Быстрый старт

## Подготовка {#prepare}
Expand Down
4 changes: 4 additions & 0 deletions ru/style/css-js.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Стизилизация
---
# Подключение CSS и JavaScript

{% note warning %}
Expand Down
4 changes: 4 additions & 0 deletions ru/style/theme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Стизилизация
---
# Темизация

Темизация настраивает визуальное оформление документации.
Expand Down
6 changes: 3 additions & 3 deletions ru/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ items:
items:
- name: Структура проекта
href: project/index.md
- name: Оглавление
- name: Оглавление проекта
href: project/toc.md
items:
- name: Несколько оглавлений
Expand All @@ -130,9 +130,9 @@ items:
href: project/navigation.md
- name: Редиректы
href: project/redirects.md
- name: Метаданные
- name: Метаданные статьи
href: project/meta.md
- name: Оглавление страницы документации
- name: Оглавление статьи
href: project/minitoc.md
- name: Конфигурация проекта
labeled: true
Expand Down
4 changes: 4 additions & 0 deletions ru/tools/docs/build.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Сборка
---
# Сборка документации

Cборка проекта выполняется командой `yfm build` с параметрами:
Expand Down
4 changes: 4 additions & 0 deletions ru/tools/docs/content.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Сборка
---
# Сборка одного файла

Команда `yfm content` обрабатывает **один** md-файл и выводит результат в `stdout` (или записывает в файл). В отличие от [`yfm build`](build.md), она не собирает полноценную страницу: для формата `html` выводится только **контент** — без оглавления, шапки и обвязки страницы.
Expand Down
6 changes: 5 additions & 1 deletion ru/tools/docs/portable.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Portable-версия CLI
---
tags:
- Инструкция
---
# Как собрать portable-версию CLI

Из пакета [@diplodoc/cli](https://www.npmjs.com/package/@diplodoc/cli) можно собрать один исполняемый файл для Windows, macOS или Linux. Внутри такого файла уже есть и сам CLI, и среда выполнения Node.js, поэтому на компьютере, где он запускается, не нужно ничего устанавливать: ни Node.js, ни npm. Интернет для работы тоже не требуется.

Expand Down
4 changes: 4 additions & 0 deletions ru/tools/docs/publish-s3.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Инструкция
---
# Выкладка на S3

Для публикации документации в [хранилище S3](https://cloud.yandex.ru/services/storage) используется команда `yfm publish`.
Expand Down
4 changes: 4 additions & 0 deletions ru/tools/docs/singlepage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
tags:
- Сборка
---
# Одностраничная сборка

{% note warning "Beta-функциональность" %}
Expand Down
2 changes: 2 additions & 0 deletions ru/tools/docs/translate-ai.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
keywords: ['translate', 'ai', 'llm', 'yandexgpt', 'openai', 'openrouter', 'anthropic', 'перевод', 'машинный перевод']
tags:
- Локализация
---
# AI-перевод

Expand Down
2 changes: 2 additions & 0 deletions ru/tools/docs/translate.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
keywords: ['translate', 'xliff', 'cat', 'i18n', 'l10n', 'localization', 'internationalization']
tags:
- Локализация
---
# Локализация

Expand Down