An open API service indexing awesome lists of open source software.

https://github.com/hseadc/hotkeys

keyboard shortcut media service
https://github.com/hseadc/hotkeys

adc bozzhik hotkeys hse shortcuts

Last synced: about 1 year ago
JSON representation

keyboard shortcut media service

Awesome Lists containing this project

README

          

# HOT KEYS - архив сочетаний клавиш

Учебный проект студентов ОП «Дизайн и Программирование» НИУ ВШЭ [B21DZ09-Project-4-2]

## Начало работы

1. Клонируйте репозиторий

```bash
git clone https://github.com/HSEADC/HOTKEYS.git
```

2. Зайдите в папку проекта

```bash
cd HOTKEYS
```

3. Установите зависимости

```bash
pnpm i
```

3. Запустите сервер для разработки

```bash
pnpm start
```

4. Сделайте билд

```bash
pnpm build
```

5. При изменении файла hotkeys.json запустите пре-рендер и генерацию страниц шорткатов shortcuts.html

```bash
pnpm render && pnpm generate
```

## Добавление шорткатов

### Описание

Файл hotkeys.json содержит данные о шорткатах для проекта. Каждый шорткат представлен в формате JSON и содержит информацию о его свойствах и использовании.

### Расположение файла

Файл hotkeys.json находится в папке /src/lib/data/ в корневой директории проекта.

### Добавление новых шорткатов
Чтобы добавить новые шорткаты в файл hotkeys.json, выполните следующие шаги:

1. Откройте файл hotkeys.json, расположенный в папке /src/lib/data/ проекта.
2. Создайте новый ключ для JSON объекта, используя приведенную выше структуру шортката.

```json
{
"link": "new-shortcut",
"selected": "Новая категория",
"text": "Описание нового шортката",
"windows": "Ctrl+N",
"macos": "Cmd+N",
"popular": true,
"useful": true,
"simple": true,
"complex": false,
"target": "application",
"page_title": "Название нового шортката",
"page_win": "Описание для Windows на странице",
"page_mac": "Описание для macOS на странице",
"page_xl_span": "Крупный текст",
"page_xl": "Описание крупного текста на странице",
"page_l_start": "Начало описания длинного текста",
"page_l_center": "Середина описания длинного текста",
"page_l_end": "Окончание описания длинного текста",
"page_l_win_first": "Ctrl",
"page_l_win_second": "N",
"page_l_mac_first": "Cmd",
"page_l_mac_second": "N"
}

```