Skip to content

Commit 92009fb

Browse files
author
Evgeniy Sukhanov
committed
Initial MkDocs manual
0 parents  commit 92009fb

32 files changed

Lines changed: 1918 additions & 0 deletions

‎.github/workflows/pages.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: true
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
26+
- name: Install uv
27+
uses: astral-sh/setup-uv@v5
28+
29+
- name: Set up Python
30+
run: uv python install
31+
32+
- name: Install dependencies
33+
run: uv sync --frozen
34+
35+
- name: Build site
36+
env:
37+
NO_MKDOCS_2_WARNING: "1"
38+
DISABLE_MKDOCS_2_WARNING: "true"
39+
run: uv run mkdocs build --strict
40+
41+
- name: Upload Pages artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: site
45+
46+
deploy:
47+
needs: build
48+
runs-on: ubuntu-latest
49+
environment:
50+
name: github-pages
51+
url: ${{ steps.deployment.outputs.page_url }}
52+
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4
57+

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.DS_Store
2+
.idea/
3+
.task/
4+
.venv/
5+
site/
6+
AGENTS.md
7+

‎README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Suzuki Jimny Sierra JB74W 5型 Manual [Russian]
2+
3+
Неофициальная русскоязычная электронная версия руководства Suzuki Jimny / Jimny Sierra JB74W.
4+
5+
Сайт публикуется через GitHub Pages и собирается на базе MkDocs Material.
6+
7+
## Локальный запуск
8+
9+
```bash
10+
uv sync
11+
uv run mkdocs serve -f mkdocs.dev.yml
12+
```
13+
14+
Или через Task:
15+
16+
```bash
17+
task serve
18+
```
19+
20+
## Правовой статус
21+
22+
Этот проект является неофициальным русскоязычным переводом и адаптацией руководства Suzuki Jimny / Jimny Sierra JB74W.
23+
24+
Оригинальные материалы, товарные знаки, иллюстрации и техническая информация принадлежат их правообладателям. Проект опубликован только в информационных и личных целях и не является официальной документацией Suzuki.
25+
26+
Если вы являетесь правообладателем и считаете, что какой-либо материал должен быть удалён или изменён, пожалуйста, создайте issue или свяжитесь с владельцем репозитория.
27+

‎Taskfile.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
version: '3'
2+
3+
tasks:
4+
install:
5+
desc: Создать локальное окружение через uv и установить зависимости
6+
cmds:
7+
- uv sync
8+
sources:
9+
- pyproject.toml
10+
- mkdocs.yml
11+
generates:
12+
- .venv/bin/mkdocs
13+
- uv.lock
14+
15+
serve:
16+
desc: Запустить локальный сервер документации
17+
deps: [install]
18+
cmds:
19+
- uv run python scripts/dev_server.py --config mkdocs.dev.yml --port 8000
20+
21+
serve-fast:
22+
desc: Запустить локальный сервер с быстрой частичной пересборкой
23+
deps: [install]
24+
cmds:
25+
- NO_MKDOCS_2_WARNING=1 DISABLE_MKDOCS_2_WARNING=true uv run mkdocs serve -f mkdocs.dev.yml --dirtyreload --watch docs --watch mkdocs.yml --watch mkdocs.dev.yml
26+
27+
build:
28+
desc: Собрать статический сайт документации
29+
deps: [install]
30+
cmds:
31+
- NO_MKDOCS_2_WARNING=1 DISABLE_MKDOCS_2_WARNING=true uv run mkdocs build --strict
32+
33+
clean:
34+
desc: Удалить сборку сайта
35+
cmds:
36+
- rm -rf site
37+
38+
reset:
39+
desc: Удалить окружение uv и артефакты сборки
40+
cmds:
41+
- rm -rf .venv site uv.lock

‎docs/00-introduction.md‎

Lines changed: 253 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/01-quick-guide.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# 1. Краткое руководство
2+
3+
## Иллюстрированное оглавление
4+
5+
### Внешний вид
6+
7+
![Внешний вид автомобиля](images/01-quick-guide/77R10300.png){ .center-image }
8+
9+
!!! tip "Оборудование по типу автомобиля"
10+
В зависимости от типа автомобиля часть оборудования может отличаться.
11+
12+
| № | Элемент | Где смотреть |
13+
| --- | --- | --- |
14+
| (1) | Антенна на крыше | [5-35](05-equipment.md) |
15+
| (2) | Указатель поворота / аварийная сигнализация на крыле или двери | [7-43](07-emergency.md) |
16+
| (3) | Боковое зеркало | [3-23](03-before-driving.md) |
17+
| (4) | Передняя камера `DSBS II` | [4-64](04-driving.md) |
18+
| (5) | Передний стеклоочиститель | [6-13](06-care.md) |
19+
| (6) | Боковой повторитель указателя поворота | [3-24](03-before-driving.md) |
20+
| (7) | Камера заднего вида | [4-141](04-driving.md) |
21+
| (8) | Задний стеклоочиститель | [6-15](06-care.md) |
22+
| (9) | Верхний стоп-сигнал | [7-43](07-emergency.md) |
23+
| (10) | Запасное колесо | [7-18](07-emergency.md) |
24+
| (11) | Заливная горловина топливного бака | [5-2](05-equipment.md) |
25+
| (12) | Дверь | [3-13](03-before-driving.md) |
26+
| (13) | Передний указатель поворота / аварийная сигнализация | [7-46](07-emergency.md) |
27+
| (14) | Передняя противотуманная фара | [7-44](07-emergency.md) |
28+
| (15) | Ультразвуковой датчик | [4-127](04-driving.md) |
29+
| (16) | Фара | [7-43](07-emergency.md) |
30+
| (17) | Буксировочный крюк | [7-5](07-emergency.md) |
31+
| (18) | Передний радар `DSBS II` | [4-64](04-driving.md) |
32+
| (19) | Капот | [5-3](05-equipment.md) |
33+
| (20) | Задняя дверь | [3-14](03-before-driving.md) |
34+
| (21) | Задний комбинированный фонарь | [7-47](07-emergency.md) |
35+
| (22) | Подсветка номерного знака | [7-48](07-emergency.md) |
36+
37+
### Интерьер 1
38+
39+
![Интерьер автомобиля](images/01-quick-guide/77R10310.png){ .center-image }
40+
41+
!!! tip "Оборудование по типу автомобиля"
42+
В зависимости от типа автомобиля часть оборудования может отличаться.
43+
44+
| № | Элемент | Где смотреть |
45+
| --- | --- | --- |
46+
| (1) | Передняя камера `DSBS II` | [4-64](04-driving.md) |
47+
| (2) | Предупреждающая наклейка о подушке безопасности SRS переднего пассажира | [2-36](02-safety.md) |
48+
| (3) | Солнцезащитный козырёк | [5-5](05-equipment.md) |
49+
| (4) | Контрольная лампа ремня безопасности заднего сиденья | [3-77](03-before-driving.md) |
50+
| (5) | Передний плафон освещения салона | [5-7](05-equipment.md) |
51+
| (6) | Микрофон Suzuki Emergency Call `Help Net` | [7-11](07-emergency.md) |
52+
| (7) | Кнопка `SOS` | [7-11](07-emergency.md) |
53+
| (8) | Микрофон hands-free | [5-36](05-equipment.md) |
54+
| (9) | Ремень безопасности переднего сиденья | [3-38](03-before-driving.md) |
55+
| (10) | Шторка безопасности SRS | [3-47](03-before-driving.md) |
56+
| (11) | Внутреннее зеркало заднего вида | [3-23](03-before-driving.md) |
57+
| (12) | Переднее сиденье | [3-29](03-before-driving.md) |
58+
| (13) | Боковая подушка безопасности SRS | [3-47](03-before-driving.md) |
59+
60+
!!! warning "Осторожно"
61+
![Предупреждающая наклейка Airbag](images/01-quick-guide/72M00150.png){ width="125" align=left }
62+
63+
Перед использованием детского сиденья обязательно прочитайте соответствующий раздел руководства.
64+
65+
На сиденье, защищённом активной фронтальной подушкой безопасности, не устанавливайте детское удерживающее устройство спиной вперёд. Это может привести к смерти или тяжёлым травмам ребёнка.
66+
67+
### Интерьер 2
68+
69+
![Интерьер автомобиля, задняя часть салона](images/01-quick-guide/77R10040.png){ .center-image }
70+
71+
!!! tip "Оборудование по типу автомобиля"
72+
В зависимости от типа автомобиля часть оборудования может отличаться.
73+
74+
| № | Элемент | Где смотреть |
75+
| --- | --- | --- |
76+
| (1) | Ремень безопасности заднего сиденья | [3-40](03-before-driving.md) |
77+
| (2) | Плафон освещения багажного отделения | [5-7](05-equipment.md) |
78+
| (3) | Розетка электропитания | [5-12](05-equipment.md) |
79+
| (4) | Заднее сиденье | [3-32](03-before-driving.md) |
80+
81+
### Интерьер 3
82+
83+
![Передняя часть салона](images/01-quick-guide/77R10320.png){ .center-image }
84+
85+
!!! tip "Оборудование по типу автомобиля"
86+
В зависимости от типа автомобиля часть оборудования может отличаться.
87+
88+
| № | Элемент | Где смотреть |
89+
| --- | --- | --- |
90+
| (1) | Боковой дефлектор | [3-24](03-before-driving.md) |
91+
| (2) | Ручка посадки пассажира | [5-16](05-equipment.md) |
92+
| (3) | Подушка безопасности SRS переднего пассажира | [3-46](03-before-driving.md) |
93+
| (4) | Переключатели аудиосистемы на рулевом колесе | [5-36](05-equipment.md) |
94+
| (5) | Подушка безопасности SRS водителя | [3-46](03-before-driving.md) |
95+
| (5) | Выключатель звукового сигнала | [3-139](03-before-driving.md) |
96+
| (6) | Переключатель адаптивного круиз-контроля | [4-107](04-driving.md), [4-117](04-driving.md) |
97+
| (7) | Перчаточный ящик | [5-10](05-equipment.md) |
98+
| (8) | Огнетушитель | [7-5](07-emergency.md) |
99+
| (9) | Рычаг регулировки наклона рулевой колонки | [3-28](03-before-driving.md) |
100+
| (10) | Ручка открывания капота | [5-3](05-equipment.md) |
101+
| (11) | Кондиционер и отопитель, ручное управление | [5-19](05-equipment.md) |
102+
| (12) | Кондиционер и отопитель, автоматическое управление | [5-24](05-equipment.md) |
103+
| (13) | Рычаг раздаточной коробки | [4-42](04-driving.md) |
104+
| (14) | Переключатель обогрева сиденья | [3-31](03-before-driving.md) |
105+
| (15) | Стояночный тормоз | [4-27](04-driving.md) |
106+
107+
### Вокруг водительского места 1
108+
109+
![Вокруг водительского места](images/01-quick-guide/77R10330.png){ .center-image }
110+
111+
!!! tip "Оборудование по типу автомобиля"
112+
В зависимости от типа автомобиля часть оборудования может отличаться.
113+
114+
| № | Элемент | Где смотреть |
115+
| --- | --- | --- |
116+
| (1) | Выключатель аварийной сигнализации | [3-136](03-before-driving.md) |
117+
| (2) | Розетка электропитания | [5-12](05-equipment.md) |
118+
| (3) | USB-разъём | [5-13](05-equipment.md) |
119+
| (4) | Переключатель стеклоочистителя и омывателя | [3-137](03-before-driving.md) |
120+
| (5) | Приборная панель | [3-72](03-before-driving.md) |
121+
| (6) | Переключатель света | [3-129](03-before-driving.md) |
122+
| (6) | Переключатель указателей поворота | [3-136](03-before-driving.md) |
123+
| (6) | Переключатель противотуманных фар | [3-134](03-before-driving.md) |
124+
| (7) | Переключатель обогрева заднего стекла | [5-31](05-equipment.md) |
125+
| (8) | Рычаг переключения передач, автомобили с МКПП | [4-28](04-driving.md) |
126+
| (8) | Система запуска с педалью сцепления, автомобили с МКПП | [4-11](04-driving.md) |
127+
| (8) | Селектор передач, автомобили с АКПП | [4-30](04-driving.md) |
128+
| (9) | Выключатель двигателя | [4-2](04-driving.md) |
129+
| (10) | Рычаг открывания лючка топливного бака | [5-2](05-equipment.md) |

‎docs/02-safety.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# 2. Обязательно к прочтению: безопасность вождения
2+
3+
## Структура главы
4+
5+
| Раздел | Страница |
6+
| --- | --- |
7+
| Обязательно к прочтению: безопасность вождения | 2-2 |
8+
9+
!!! note "Статус"
10+
Глава пока не заполнена. Сюда будем добавлять подтверждённые переводы страниц из раздела 2.

‎docs/03-before-driving.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 3. Перед началом движения
2+
3+
## Структура главы
4+
5+
| Раздел | Страница |
6+
| --- | --- |
7+
| Открывание и закрывание дверей | 3-2 |
8+
| Охранная система | 3-17 |
9+
| Открывание и закрывание окон | 3-20 |
10+
| Регулировка различных элементов | 3-23 |
11+
| Регулировка сидений | 3-29 |
12+
| Ремни безопасности | 3-37 |
13+
| Подушки безопасности SRS | 3-46 |
14+
| Детские удерживающие устройства | 3-59 |
15+
| Комбинация приборов | 3-72 |
16+
| Использование переключателей | 3-129 |
17+
18+
!!! note "Статус"
19+
Глава пока не заполнена. Сюда будем добавлять подтверждённые переводы страниц из раздела 3.

‎docs/04-driving.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 4. Во время движения
2+
3+
## Структура главы
4+
5+
| Раздел | Страница |
6+
| --- | --- |
7+
| Запуск и остановка двигателя | 4-2 |
8+
| Бензиновый сажевый фильтр GPF | 4-16 |
9+
| Система автоматической остановки двигателя на холостом ходу | 4-17 |
10+
| Стояночный тормоз | 4-27 |
11+
| Рычаг переключения передач | 4-28 |
12+
| Автомобиль с автоматической коробкой передач | 4-30 |
13+
| Автомобиль с приводом 4WD | 4-42 |
14+
| ESP | 4-48 |
15+
| Suzuki Safety Support | 4-62 |
16+
| Камера заднего вида | 4-141 |
17+
18+
!!! note "Статус"
19+
Глава пока не заполнена. Сюда будем добавлять подтверждённые переводы страниц из раздела 4.

‎docs/05-equipment.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# 5. Использование оборудования
2+
3+
## Структура главы
4+
5+
| Раздел | Страница |
6+
| --- | --- |
7+
| Основное оборудование | 5-2 |
8+
| Кондиционер и отопитель | 5-17 |
9+
| Аудиосистема | 5-35 |
10+
11+
!!! note "Статус"
12+
Глава пока не заполнена. Сюда будем добавлять подтверждённые переводы страниц из раздела 5.

0 commit comments

Comments
 (0)