Chiodocs

Вот так выглядит главная страница документации.

Сайт со статической документацией для Chiori.

Содержит:

• Главная страница с новостями.
• Описание всех расширений и бибилиотек.
• Индекс плагинов для более удобного поиска.
• Инструкция по установке, настройке и модификации Шиори.
• как начать пользователься Шиори.
• Условия использовать и политика конфиденциальности.

Документация написана с использованием Vitepress. Это позволяет собирать очень красивую документацию на основа MarkDowm файлов. В этом проекте не используется связка с Obsidian.

Также для индекса плагинов использовались собственные компоненты. Собственные компоненты открывают безграничные возможности для товрчества.

Сборка документации

Обратите внимени, что данная документация полностью изготовлена под Chiori от Salormoon, материалы для сборки предоставляются в ознакомительных целях. Если вы хотиет развернуть свою собственную документацию, то пожалуйста внесите перед этим значительные изменения в исходный код проекта.

1. Клонируем репозиторий на сервер.

git clone https://codeberg.org/Salormoon/chiodocs
cd chiodocs

2. Устанавливаем Vitepress при помощи Bun.

bun i

3. Собираем оптимизированную документацию.

bun docs:build

Вот и всё, документация была собрана в каталог chio/.