Полная справка по системе вики

Эта система — файловая вики, полностью работающая на Markdown. Ниже описано ВСЁ, что поддерживается.

1. Структура проекта

content/ — все страницы
public/assets/ — все ассеты (иконки, картинки)

Раздел = папка
Страница = .md файл
index.md — главная страница раздела

2. Front matter

---
title: "Название"
desc: "Описание"
order: 1
icon: book
hideTitle: false
header: /assets/headers/demo.png
headerHeight: 240
---

3. Заголовок страницы

• По умолчанию отображается
• Можно скрыть через hideTitle: true
• Иконка страницы отображается рядом с заголовком

4. Иконки

Папка: public/assets/icons
Форматы: svg, png

Использование:

• Раздел: icon в index.md
• Страница: icon в .md
• Callout: icon
• Инлайн:

5. Callout

Заголовок

type: info text: Текст

Типы: info, warning, success, error

6. Обычные изображения

7. Галерея

8. Инлайн элементы

9. Градиентный текст

Текст

10. Цветной текст

Текст

11. Ссылки

Раздел
Страница

12. Навигация

ЛКМ — свернуть/развернуть
ПКМ — свернуть/развернуть
Ctrl/Cmd — перейти

13. Ассеты

Только латиница
Пути от /assets/

14. Редактирование

Любой редактор Markdown. Сохранил — обновил страницу.

15. Философия

Просто. Предсказуемо. Расширяемо.