ALT Gnome Wiki

База знаний открытого сообщества пользователей операционной системы ALT Linux с графическим окружением GNOME.

Разработка

Перед запуском проекта убедитесь, что у вас установлены необходимые компоненты

sudo apt-get install node git

Выполним загрузку репозитория, перейдём в каталог проекта и запустим в режиме разработки

git clone https://github.com/OlegShchavelev/ALTGnomeWiki.git
cd ALTRegularGnomeWiki
npm i
npm run docs:dev

Дополнительный функционал

Включение динамической сортировки участников на главной странице

Для работы функции требуется создать read-only токен GitHub

(Оффициальный REST API GitHub не предоставляет данные об активности в репозитории без авторизации. Поэтому для использования данного функционала требуется ключ с правом на чтение публичных репозиториев)

Как это сделать можно прочитать тут

Далее для локального использования нужно создать файл .env в папке /docs/ и добавить в него данную строку:

VITE_GIT_KEY="{ваш токен}"

(Данный файл добавлен в исключения .gitignore, можно не бояться, что он уйдет в репозиторий)

А для использования функционала в сборке нужно создать secret c названием VITE_GIT_KEY для GitHub Actions в вашем репозитории

Как это сделать можно ознакомиться здесь

После этого будет доступен функционал сортировки.

(На данный момент данный ключ используется только в .vitepress/utils/gitStats.js, если вы не доверяете проекту - вы можете проверить как ваш ключ используется ведь все компоненты имеют открытый исходный код. Либо вы можете просто не использовать данный функционал. Все остается на ваше усмотрение.)

Настройки динамической сортировки

Можно настроить количество и тип сортировки топа в /_data/team.ts

Зеркало

Вся документация из этого репозитория размещается на сайте alt-gnome.wiki автоматически.

Лицензия

MIT Copyright © 2023-present OLEG SHCHAVELEV