Skip to content

Commit

Permalink
README: небольшие правки
Browse files Browse the repository at this point in the history
  • Loading branch information
X1Z53 committed Aug 25, 2024
1 parent 8c4c09b commit f0a90db
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@

## Разработка

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

```
```shell
sudo apt-get install node git
```

Expand All @@ -37,7 +37,7 @@ npm run docs:dev

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

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

[Как это сделать можно прочитать тут](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
Expand All @@ -48,29 +48,29 @@ npm run docs:dev
VITE_GIT_KEY="{ваш токен}"
```

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

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

[Как это сделать можно ознакомиться здесь](https://docs.github.com/actions/security-guides/encrypted-secrets)

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

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

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

- homeTopLimit - Лимит отображаемых пользователей на главной странице
- home_filter_type - Тип сортировки пользователей на главной странице
- page_filter_type - Тип сортировки пользователей на странице команды
- `homeTopLimit` — лимит отображаемых пользователей на главной странице
- `home_filter_type` — тип сортировки пользователей на главной странице
- `page_filter_type` — тип сортировки пользователей на странице команды

1. 'additions' - по количеству добавленых в репозиторий строк
2. 'commits' - по количеству коммитов в репозиторий
3. 'role+additions' - по роли участника (Разработчик -> Участник) и количеству добавленых в репозиторий строк
4. 'role+commits' - по роли участника (Разработчик -> Участник) и количеству коммитов
1. `additions` по количеству добавленных в репозиторий строк
2. `commits` по количеству коммитов в репозиторий
3. `role+additions` по роли участника (Разработчик -> Участник) и количеству добавленных в репозиторий строк
4. `role+commits` по роли участника (Разработчик -> Участник) и количеству коммитов

- enable_autosearch - Включено/выключено автозаполнение перечня участников из статистики
- loading_placeholders - Массив с возможными выводами у спиннера загрузки виджета
- `enable_autosearch` — включено/выключено автозаполнение перечня участников из статистики
- `loading_placeholders` — массив с возможными выводами у спиннера загрузки виджета

## Зеркало

Expand Down

0 comments on commit f0a90db

Please sign in to comment.