Skip to content

Commit

Permalink
Document PC Navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
3y3 committed Dec 28, 2023
1 parent a716524 commit ff1dcc9
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 0 deletions.
18 changes: 18 additions & 0 deletions en/toc.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
title: Diplodoc
href: index.yaml
navigation:
logo:
url: 'https://diplodoc.com'
dark:
icon: 'https://storage.yandexcloud.net/diplodoc-www-assets/logo/ddos-logo-dark.svg'
light:
icon: 'https://storage.yandexcloud.net/diplodoc-www-assets/navigation/diplodoc-logo.svg'
header:
leftItems:
- text: 'How it works'
type: 'link'
url: 'https://diplodoc.com/how-to/'
- text: 'Documentation'
type: 'link'
url: 'https://diplodoc.com/docs/en/'
- text: 'Github'
type: 'link'
url: 'https://github.com/diplodoc-platform/'
items:
- name: Overview
href: about.md
Expand Down
53 changes: 53 additions & 0 deletions ru/project/navigation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Расширенная навигация

Платформа поддерживает гибкую настройку верхней навигации ("шапки") на странице.
Для этого используется пакет [page-constructor](https://gravity-ui.com/libraries/page-constructor).

В [StoryBook](https://preview.gravity-ui.com/page-constructor/?path=/docs/navigation-navigation--docs) можно ознакомиться с примерами конфигурации навигации.

## Настройка

{% note warning %}

Стоит учитывать, что, при использовании расширенной навигации, вся развертка страницы переходит в режим page-constructor.
Т.е. будут отличаться отсуты контента от краев экрана.

Так же в этом режиме игнорируются любые настройки навигации из `.yfm` файла.

{% endnote %}

Блок конфигурации добавляется в `toc.yaml` следующим образом:

```yaml
title: Docs navigationExample
href: index.md
navigation:
logo:
url: 'https://diplodoc.com'
dark:
icon: 'https://storage.yandexcloud.net/diplodoc-www-assets/logo/ddos-logo-dark.svg'
text: 'Diplodoc'
light:
icon: 'https://storage.yandexcloud.net/diplodoc-www-assets/navigation/diplodoc-logo.svg'
text: 'Diplodoc'
header:
leftItems:
- text: 'Relative Link'
type: 'link'
url: './ru/settings'
- text: 'Absolute Link'
type: 'link'
url: 'https://diplodoc.com/docs/ru/project/'
rightItems:
- text: 'Other Link'
type: 'link'
url: 'ru/contribution'
- type: controls
```
Относительные ссылки расчитываются всегда от корня проекта, на каком бы уровне не находился toc.yaml
## Специальные элементы
- `controls` - отвечает за позицию размещения поиска и настроек в навигации.
Если не указан вручную, то автоматически добавляется последним элементов в `rightItems`.
23 changes: 23 additions & 0 deletions ru/toc.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
title: Diplodoc
href: index.yaml
navigation:
logo:
url: 'https://diplodoc.com'
dark:
icon: 'https://storage.yandexcloud.net/diplodoc-www-assets/logo/ddos-logo-dark.svg'
light:
icon: 'https://storage.yandexcloud.net/diplodoc-www-assets/navigation/diplodoc-logo.svg'
header:
leftItems:
- text: 'Как все устроено'
type: 'link'
url: 'https://diplodoc.com/how-to/'
- text: 'Документация'
type: 'link'
url: 'https://diplodoc.com/docs/ru/'
- text: 'Тelegram'
type: 'link'
url: 'https://t.me/diplodoc_ru'
- text: 'Github'
type: 'link'
url: 'https://github.com/diplodoc-platform/'
items:
- name: Обзор системы
href: about.md
Expand Down Expand Up @@ -49,6 +70,8 @@ items:
href: project/index.md
- name: Оглавление
href: project/toc.md
- name: Расширенная навигация
href: project/navigation.md
- name: Разводящая страница
href: project/leading-page.md
- name: Пресеты переменных
Expand Down

0 comments on commit ff1dcc9

Please sign in to comment.