Начало работы
Откройте папку с Markdown или создайте новую документацию, освойтесь в окне и напишите первую страницу.
Откройте документацию
Kirbon работает с обычной папкой Markdown-файлов — папкой с документацией, Git-репозиторием или папкой с заметками. Ничего не нужно импортировать или конвертировать.
- Откройте Kirbon. В окне приветствия есть Открыть папку… (⌘O), Новая документация… и недавние папки.
- Выберите папку с
.md-файлами. Папку можно и просто перетащить на окно приветствия или на значок Kirbon в Dock. - Окно откроется, как только будет готов список страниц. Индекс для поиска строится в фоне — читать и править можно сразу.
Kirbon просит у macOS доступ только к тем папкам, которые вы выбрали. Он их запоминает: в следующий раз они открываются из списка Недавние или сами при запуске Kirbon. Если папку переместили или удалили, она будет отмечена в списке. Те же папки есть в Файл ▸ Открыть недавние, где Очистить меню забывает все, кроме открытых, и в переключателе документации вверху бокового меню — он же выводит вперед уже открытую документацию. Чтобы окно приветствия не появлялось, снимите в нем флажок Показывать это окно при открытии Kirbon.
С чистого листа
Файл ▸ Новая документация… спросит название и место, создаст папку с главной страницей (README.md с названием в заголовке) и откроет ее.
Освойтесь в окне
| Часть окна | Для чего |
|---|---|
| Боковое меню | Главная, разделы и страницы документации, избранное и фильтр страниц. |
| Панель инструментов | «Назад» и «Вперед», название страницы и ее статус, элементы форматирования, три режима, поиск и сведения о странице. |
| Страница | Сама страница. Кликните в любом месте и пишите — кнопки «Править» нет. |
| Инспектор | Структура и Сведения страницы: ⌥⌘O и ⌥⌘I. |
Статус под названием страницы показывает, что происходит с файлом: название раздела, пока ничего не менялось, затем Несохраненные изменения, Сохранение… и Сохранено. Подробнее — в разделе Сохранение и изменения на диске.
Напишите первую страницу
- Выберите Файл ▸ Новая страница (⌘N). В текущем разделе появится страница «Без названия», а курсор встанет в заголовок.
- Введите название и нажмите Return. Kirbon назовет файл по заголовку: «Заметки к релизу» станет
заметки-к-релизу.md. - Пишите. Наберите / в начале строки, чтобы вставить таблицу, выноску, блок кода или изображение.
Если уйти с новой страницы, ничего не написав, файл не создается. Когда файл уже есть, смена заголовка сама его не переименует: вместо этого под заголовком появится Переименовать файл и обновить ссылки….
Что происходит с файлами
Kirbon читает и записывает обычный Markdown. Открытие страницы ничего не меняет; при правке переписываются только измененные блоки. Kirbon не добавляет в страницы метаданные — единственный файл, который он может создать, это маленький .pages, когда вы сами меняете порядок страниц. Подробнее — в разделе Какие файлы создает Kirbon.