Переезд с вики
Пространства, родительские страницы, панели и вложения — и где каждое из них живет на диске.
Те же понятия, только в файлах
Если команда привыкла к облачной вики, большинство привычек сохранится. Отличие в том, где все хранится: в Kirbon каждая вещь — это файл в папке, которой распоряжаетесь вы.
| В вики | В Kirbon | На диске |
|---|---|---|
| Пространство | Документация | Папка, которую вы открыли |
| Главная страница | Главная | README.md в корне папки |
| Дерево страниц | Боковое меню ▸ Страницы | Папки и .md-файлы |
| Родительская страница | Страница с дочерними | команда/README.md и страницы рядом с ним |
| Название страницы | Первый заголовок страницы | # Первая неделя |
| Вложения | Изображения и файлы | assets/<страница>/… |
| Панели Info, Note, Warning | Выноски | > [!NOTE], > [!WARNING] … |
| Ссылки на страницы | Ссылки на страницы и заголовки | Относительные пути, например ../продукт/тарифы.md |
| История страницы | Ваш Git-клиент | git log |
Перенесите страницы
- Экспортируйте в Markdown. Большинство вики умеют выгружать пространство в Markdown или в HTML, который конвертер превратит в Markdown. Одна страница — один
.md-файл. - Разложите по папкам. Сделайте папку для каждого раздела и положите в нее страницы. Обзорную страницу раздела назовите
README.md. - Проверьте названия. Kirbon берет название страницы из ее первого заголовка
#. Страница без него называется по имени файла. - Откройте папку в Kirbon и пройдитесь по дереву страниц. Битые ссылки подчеркнуты красным пунктиром и перечислены в сведениях о странице.
- Поправьте выноски. Панели становятся GitHub alerts:
> [!NOTE],> [!TIP],> [!IMPORTANT],> [!WARNING]или> [!CAUTION]. Тип любой выноски можно сменить из ее меню прямо в Kirbon.
Панели и выноски
| Панель вики | Выноска Kirbon | Markdown |
|---|---|---|
| Info | Примечание | > [!NOTE] |
| Tip | Совет | > [!TIP] |
| Note | Важно | > [!IMPORTANT] |
| Warning | Предупреждение | > [!WARNING] |
| Error | Осторожно | > [!CAUTION] |
Совместная работа
В Kirbon нет совместной правки в реальном времени. Команды делят папку через Git или синхронизируемый диск, а Kirbon разбирается с изменениями, когда они приходят: страница без ваших правок обновляется на месте, а у страницы, которую вы правите, автосохранение встает на паузу и появляется Сравнить версии…. Подробнее — в разделе Kirbon и Git.
Для читателей ничего не меняется
Kirbon пишет Markdown в стиле GitHub с относительными ссылками и GitHub alerts, поэтому на GitHub и GitLab страницы выглядят так же. Коллеги без Kirbon открывают их в любом редакторе.