diff --git a/ru/project/leading-page.md b/ru/project/leading-page.md index 6c0d3e4c..b9cc2cb0 100644 --- a/ru/project/leading-page.md +++ b/ru/project/leading-page.md @@ -34,6 +34,22 @@ links: Описания документа и разделов **не поддерживают** markdown-разметку. +## Открытие ссылок в новой вкладке {#target} + +По умолчанию, все относительные ссылки на разводящей открываются в текущей вкладке браузера, все абсолютные ссылки – в новой вкладке. Это поведение можно менять с помощью параметра `target`: + +* `_self` — ссылка будет открываться в текущей вкладке, +* `_blank` — ссылка будет открываться в новой вкладке. + +```yaml +- title: Абсолютная ссылка + href: https://github.com + target: _self +- title: Отдельный раздел в документации + href: ./some-internal-page/ + target: _blank +``` + ## Условия видимости элементов {#when} Отдельные разделы можно отображать или не отображать на разводящей странице в зависимости от значений [переменных](../syntax/vars.md). Для описания условий видимости используется параметр `when`. diff --git a/ru/project/navigation.md b/ru/project/navigation.md index f4807c0d..d3aa5080 100644 --- a/ru/project/navigation.md +++ b/ru/project/navigation.md @@ -1,11 +1,12 @@ # Расширенная навигация Платформа поддерживает гибкую настройку верхней и нижней навигации («шапки» и «подвала») на странице. + Для этого используется пакет [page-constructor](https://gravity-ui.com/libraries/page-constructor). В [StoryBook](https://preview.gravity-ui.com/page-constructor/?path=/docs/navigation-navigation--docs) можно ознакомиться с примерами конфигурации навигации. -## Верхнее меню {#header} +## Логотип {#logo} -Конфигурация верхнего меню добавляется в `toc.yaml` следующим образом: +Логотип в верхнем меню задается в `toc.yaml` с помощью параметра `navigation.logo`: ```yaml navigation: @@ -18,6 +19,14 @@ navigation: light: icon: 'https://storage.yandexcloud.net/diplodoc-www-assets/navigation/diplodoc-logo.svg' text: 'Diplodoc' +``` + +## Верхнее меню {#header} + +Конфигурация верхнего меню добавляется в `toc.yaml` следующим образом: + +```yaml +navigation: header: leftItems: - text: 'Relative Link' @@ -103,7 +112,7 @@ navigation: || || - ```yaml + ```yaml wrap - type: dropdown text: 'Dropdown' items: @@ -198,7 +207,7 @@ navigation: На первом уровне, в выпадающих списках, группах элементов и ссылок доступен элемент: -- `link` — ссылка, свойство `url` содержит текст ссылки; относительные ссылки всегда рассчитываются от корня проекта, на каком бы уровне ни находился ##toc.yaml##. +- `link` — ссылка, свойство `url` содержит текст ссылки, `target: _blank` включает открытие ссылки в новой вкладке; относительные ссылки всегда рассчитываются от корня проекта, на каком бы уровне ни находился ##toc.yaml##. ## Нижнее меню {#footer} diff --git a/ru/project/toc.md b/ru/project/toc.md index 175bdd85..57339735 100644 --- a/ru/project/toc.md +++ b/ru/project/toc.md @@ -33,6 +33,7 @@ items: * `title` — название документа. Отображается в оглавлении над списком всех разделов. Можно скрыть его отображение с помощью настройки ##interface: toc-header## в [файле .yfm](../settings.md#toc-header). * `href` — относительный путь до файла. * `items` — пункты оглавления. +* `navigation` – секция настроек [расширенной навигации](./navigation.md). Каждый пункт оглавления содержит поля: @@ -48,6 +49,19 @@ items: > Смотри также: [Ajv схема файлов оглавления toc.yaml](https://raw.githubusercontent.com/diplodoc-platform/ajv/refs/heads/master/src/json/toc-schema.json) +## Открытие ссылок в новой вкладке {#target} + +По умолчанию, все относительные ссылки в оглавлении открываются в текущей вкладке браузера, все абсолютные ссылки – в новой вкладке. Это поведение можно менять с помощью параметра `target`: + +* `_self` — ссылка из оглавления будет открываться в текущей вкладке, +* `_blank` — ссылка из оглавления будет открываться в новой вкладке. + +```yaml +- name: Абсолютная ссылка + href: https://github.com + target: _self +``` + ## Условия видимости разделов {#when} Отдельные разделы можно включать или не включать в документ в зависимости от значений [переменных](../syntax/vars.md). Для описания условий видимости используется параметр `when`. diff --git a/ru/syntax/base.md b/ru/syntax/base.md index a36f5ef0..fc88f88d 100644 --- a/ru/syntax/base.md +++ b/ru/syntax/base.md @@ -66,7 +66,7 @@ По умолчанию якорь в YFM — это текст заголовка, записанный в латинской транслитерации. Вы можете задать якорь вручную, указав его после заголовка: ```markdown -## Заголовок h2 {#anchor} +## Заголовок h2 {#anchor-example} ``` Чтобы одновременно с якорями в стиле YFM также генерировались якоря по правилам GitHub, в [настройках](../settings.md) задайте значение `supportGithubAnchors: true`. diff --git a/ru/syntax/links.md b/ru/syntax/links.md index f2ad9bf6..ead9fda5 100644 --- a/ru/syntax/links.md +++ b/ru/syntax/links.md @@ -1,7 +1,8 @@ # Ссылки Стандартная разметка для ссылки имеет вид: -``` + +```markdown [текст_ссылки](ссылка "текст_подсказки") ``` @@ -11,6 +12,15 @@ В зависимости от вида ссылки допускаются упрощения и другие варианты оформления. +## Открытие в новой вкладке {#target} + +По умолчанию, все относительные ссылки открываются в текущей вкладке браузера, все абсолютные ссылки – в новой вкладке. Можно переопределить это поведение с помощью атрибута `target`. + +Примеры: + +* `[текст](ссылка){target=_blank}` — будет открываться в новой вкладке, +* `[текст](ссылка){target=_self}` — будет открываться в текущей вкладке. + ## Ссылка на md-файл {#autotitle} Вы можете оформить ссылку на md-файл без явного указания текста ссылки. Для этого добавьте сочетание символов `{#T}` на место текста, и он подставится автоматически из заголовка указанного файла. @@ -37,7 +47,7 @@ * на раздел другой страницы. - `[text](base.md#anchor)` + `[text](base.md#headers)` **Результат** @@ -110,7 +120,7 @@ This is the _[YFM Guide](https://yadocs.tech)_. See the section on [`code`](#code). Super [^men^](https://en.wikipedia.org/wiki/Major_Grom_(2017_film)). -## Произвольные файлы {#files} +## Ссылки для скачивания файлов {#files} Чтобы выложить файлы для скачивания, загрузите их на внешнее хранилище.