Я невероятно рад представить вам новый портал документации для ОСени и осенних проектов:
https://autumn-library.github.io/
Огромное спасибо Антону @JKIee Титовцу за исходный дизайн и структуру сайта. Ты дал хороший пинок в правильном направлении, и предложенный тобой сайтогенератор оказался удобным и функциональным.
Не менее огромное спасибо Кириллу @sfaqer Черненко, с которым мы потом активно доводили сайт под наши пожелания и наполняли контентом.
Итак, что же вас ждет на сайте?
* Модернизированная документация по самой ОСени. Общий смысл остался тот же, но теперь он разбит на разделы, местами улучшена подсветка кода и его представление.
* Документация по winow тоже теперь живёт здесь, на разделы пока не разбита.
* Под этот же зонтик перенесена документация по annotations и autumn-collections
* Наконец-то (НАКАНЕЦТА) есть полное описание программного интерфейса всех аннотаций, классов, желудей, модулей, напильников, перечислений, деталек и всего-всего, что есть в публичной части ядра ОСени. Все (почти) аннотации имеют подробное описание, когда и как их можно применять. Остальные части API не всегда имеют описания, но сигнатуры методов точно доступны.
* Так же API имеют annotations и autumn-collections.
И все это на едином сайте!
Немного по структуре сайта:
* темная тема по умолчанию (но есть переключалка на светлую)
* сверху находится панель навигации, на которой можно перейти в документацию того или иного продукта и посмотреть его API (пнреключалки)
* справа выводится оглавление текущей страницы по маркдаун-заголовкам
* слева выводится панель разделов и страниц
* есть ПОИСК (божечки)
* планируется перевести на этот сайт все остальные осенние проекты, добавить API winow, на полную использовать возможности код-блоков - вкладки, фокус на строках, диффы, перетекание
Техническая составляющая:
* сайт построен на vitepress 1.5.0 (актуальная на данный момент версия, за обновлением зависимостей следит dependabot)
* применено немного кастомных стилей поверх тем vitepress-dark и vitepress-light
* деплоится на GitHub Pages из репозитория https://github.com/autumn-library/autumn-library.github.io
* сейчас все куски документации лежат в репозитории сайта, в будущем планируется перенести их обратно в репозитории продуктов и настроить автосборку по склонированным репозиториям по списку
* ни один из штатных генераторов сайдбаров не подошёл, поэтому мы написали свой х)
* каждая страница - отдельный маркдаун файл. Для сортировки применяются невидимая нумерация в начале имён файлов, которая вырезается на сайдбаре и через рерайты.
Ну как вам, ну как?
Post #526
3.46K
- 🔥 55
- 👍 10
- ❤ 8