Страницы и разделы
Как папки превращаются в дерево страниц и как создавать, переименовывать, перемещать, упорядочивать и добавлять страницы в избранное.
Как строится дерево страниц
Kirbon показывает папку как дерево разделов и страниц:
- Каждый
.md-файл — это страница. Ее название — первый заголовок#, а без него — имя файла. - Каждая папка — это раздел. Ее
README.md(илиindex.md, если README нет) — собственная страница раздела, и раздел показывается как страница с дочерними. README.mdв корне папки — это Главная, а ее заголовок — название документации. Без нее документация называется по имени папки.- Скрытые файлы, папка
assets/и папки без единого Markdown-файла внутри не показываются.
Страницы сортируются по названию. Чтобы задать порядок самому, перетаскивайте страницы в боковом меню: Kirbon запишет в этой папке маленький файл .pages — по одному имени в строке. Его можно править и вручную.
Пустые папки и разделы
Папка без единого Markdown-файла открывается с надписью «Страницы не найдены.» и кнопками Новая страница и Выбрать другую папку…. Раздел без собственной страницы показывает свое название и оглавление страниц и подразделов ссылками — а если он пуст, то короткую подсказку, — и кнопку Превратить в страницу, которая дает ему страницу.
Когда вы впервые открываете документацию, Kirbon раскрывает разделы верхнего уровня; дальше дерево помнит, что вы раскрыли и свернули, даже когда файлы меняются на диске.
Создайте страницы и разделы
| Что создать | Как |
|---|---|
| Страницу в текущем разделе | Файл ▸ Новая страница (⌘N), «+» вверху бокового меню или «+» в строке раздела |
| Страницу внутри выбранной | Файл ▸ Новая дочерняя страница (⇧⌘N) |
| Раздел | Файл ▸ Новый раздел… — папка с README.md |
| Страницу или раздел в корне | Наведите указатель на Страницы вверху дерева: + создает страницу там; в ⋯ (или по правому щелчку) — Новая страница в «документация» и Новый раздел… |
Когда у страницы без дочерних появляется первая дочерняя, Kirbon сначала спросит и объяснит, что изменится: тарифы.md станет тарифы/README.md, а ссылки на нее обновятся.
Меню страницы
Кликните страницу в боковом меню правой кнопкой или нажмите «⋯» в ее строке — там все, что с ней можно сделать.
Переименуйте страницу
Выберите Переименовать… — или выделите строку и нажмите Return. В окне видно новое название, смену имени файла (old.md → new.md) и сколько ссылок в других страницах обновится. Одна отмена возвращает и название, и имя файла, и ссылки.
Новый заголовок, набранный на странице, никогда не переименовывает файл. Когда они перестают совпадать, под заголовком появляется Переименовать файл и обновить ссылки….
Перемещение и порядок
- Перетащите страницу на раздел, чтобы переместить ее туда, или между строками — чтобы поставить ее в это место. С ⌥ страница копируется. Туда, куда страницу поставить нельзя, курсор показывает ⊘.
- Переместить в… делает то же с клавиатуры: отфильтруйте разделы, выберите нужный, нажмите Return.
- Если в разделе уже есть страница с таким именем файла, выберите Оставить обе, Заменить… или Остановить.
Ссылки на страницу из других страниц и ее собственные относительные ссылки и пути к изображениям переписываются вместе с перемещением. Внизу бокового меню появится сообщение, сколько ссылок обновлено, с кнопкой отмены.
Дублирование, превращение и удаление
- Дублировать страницу (⌘D) делает «Название копия» рядом с оригиналом, с поправленными ссылками.
- Превратить в папку… возвращает страницу с дочерними в обычную папку; Превратить в страницу дает папке собственную страницу
README.md. - Добавить главную страницу создает в документации без Главной собственный
README.mdс названием документации — в меню Файл или в ⋯ у Страницы вверху дерева. Удалить главную страницу… (в меню Файл и на строке Главной) перемещает Главную в Корзину; остальные страницы остаются на своих местах, а если в Главной есть текст или на нее ссылаются другие страницы, Kirbon сначала спросит. - Переместить в Корзину (⌘⌫ в боковом меню) переносит файл в системную Корзину, предварительно сказав, сколько страниц на него ссылается. Вложения страницы остаются.
Ссылка на страницу и файл
- Скопировать ссылку на страницу (меню «Правка» или меню страницы) копирует Markdown-ссылку вида
[Дорожная карта 2027](продукт/дорожная-карта-2027.md). Вставленная на страницу в режиме «Визуальный», она становится ссылкой относительно этой страницы. - С ⌥ — Скопировать путь к файлу: полный путь к файлу, для Терминала или другой программы.
- Показать в Finder показывает файл страницы.
Боковое меню с клавиатуры
| Клавиша | В боковом меню |
|---|---|
| ↑ ↓ | Выбрать страницу; она откроется после короткой паузы. Space открывает сразу. |
| → ← | Раскрыть; свернуть или перейти к родителю. |
| Набор текста | Переход к странице, название которой начинается с набранного. |
| Return | Переименовать… |
| ⌘⌫ | Переместить в Корзину. |
| Esc | Очистить фильтр страниц. |
Ширину бокового меню можно менять от 200 до 400 точек, а скрыть его — ⌃⌘S; само оно страницу никогда не перекрывает.
Избранное и навигация
Добавляйте частые страницы командой Добавить в избранное — они появятся в разделе «Избранное» вверху бокового меню и в Переход ▸ Избранное, во всех окнах этой документации. Удалить из избранного убирает страницу из списка. Избранное следует за страницами, которые вы переименовываете или перемещаете в Kirbon. Избранное хранится на вашем Mac, а не в папке. Чтобы свернуть список, нажмите стрелку, которая появляется при наведении на Избранное; каждое окно это помнит.
Хлебные крошки над заголовком показывают, где лежит страница; каждая часть — ссылка, а последняя открывает меню соседних страниц и заголовков этой страницы. Назад и Вперед (⌘[ ⌘]) работают как в браузере, а Показать в боковом меню (⇧⌘J) находит текущую страницу в дереве.