-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support page. Refactor index pages (#199)
- Loading branch information
Showing
13 changed files
with
190 additions
and
54 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| # Support and contributing | ||
|
|
||
| ## Donation and support | ||
|
|
||
| If you liked this project and are ready to support it for further development, | ||
| you can do so using Bitcoin: | ||
|
|
||
| <div class="grid cards" markdown> | ||
|
|
||
| - :fontawesome-brands-btc:{ .lg .middle } __Cryptocurrency__ | ||
|
|
||
| --- | ||
| { width="100" align=left } | ||
|
|
||
| BTC Wallet: `1BKR5d91YUic3aqwc6nTGTMLkGBBrZkkcj` | ||
|
|
||
| </div> | ||
|
|
||
| ## Contributing | ||
|
|
||
| ### Structure of the project | ||
|
|
||
| Path to docs: `/docs` | ||
| Path to images: `/docs/images` | ||
| Path to firmwares: `/docs/firmwares` | ||
| Path to parameter files: `/docs/parameters` | ||
| Path to templates (e.g. used in utils): `/overrides/pages` | ||
|
|
||
| Main configuration file: `mkdocs.yml` | ||
|
|
||
| ### Adding new codings | ||
|
|
||
| You can use the template below to add new codings | ||
|
|
||
| ``` | ||
| ### Name of coding / adaptation | ||
| !!! tip "" | ||
| Tip/info message | ||
| !!! warning "" | ||
| Some warning message | ||
| ``` yaml title="логин-пароль: XXXXX (if applicable)" | ||
| Block XX → Adaptation/Coding: | ||
| Byte XX – Bit X (name): Active | ||
| Name of volume/folder: | ||
| - Name of parameter: activate | ||
| → Apply | ||
| ``` | ||
| ??? note "Collapsibale list" | ||
| This information is displayed collapsed on the site | ||
| ``` | ||
|
|
||
| Inserting image to the page: | ||
| `````` | ||
|
|
||
| Inserting file to the page: | ||
| ```[(Name of file)](LinkToFile)``` | ||
|
|
||
| ### Adding localizations | ||
|
|
||
| If you want to help in translating this site to English language, please contribute a localization! | ||
|
|
||
| Follow these steps to add a localization: | ||
|
|
||
| 1. Copy particular file in /docs directory to new with lang suffix. Example: drive.md → drive.en.md | ||
| 2. Start translating the strings | ||
| 3. Edit mkdocs.yaml and edit the following variables. Make sure that all navigation items translated correctly | ||
| ```yaml | ||
| nav_translations: | ||
| Name in Russian: Name in English | ||
| ``` | ||
| 4. Create a PR with your localization updates. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Поддержка и развитие проекта | ||
|
|
||
| ## Помощь проекту | ||
|
|
||
| Если вам понравился этот проект и вы готовы его поддержать для дальнейшего развития, | ||
| то вы можете это сделать с помощью Яндекс-перевода в рублях или биткоина: | ||
|
|
||
| <div class="grid cards" markdown> | ||
|
|
||
| - :fontawesome-solid-money-bill:{ .lg .middle } __Перевод с российских карт__ | ||
|
|
||
| --- | ||
| Перевод в рублях c помощью карты или кошелька Яндекс | ||
|
|
||
| [Поддержать :fontawesome-solid-paper-plane:](https://yoomoney.ru/to/4100110582992748/100){ .md-button } | ||
|
|
||
| - :fontawesome-brands-btc:{ .lg .middle } __Криптовалюта__ | ||
|
|
||
| --- | ||
| { width="100" align=left } | ||
|
|
||
| Перевод на BTC кошелек: `1BKR5d91YUic3aqwc6nTGTMLkGBBrZkkcj` | ||
|
|
||
| </div> | ||
|
|
||
| ## Добавление новых материалов | ||
|
|
||
| ### Структура сайта | ||
|
|
||
| Путь для хранения изображений: `/docs/images` | ||
| Путь до прошивок: `/docs/firmwares` | ||
| Путь до параметрий: `/docs/parameters` | ||
|
|
||
| ### Добавление новых кодировок | ||
|
|
||
| Данный сайт построен с использованием языка разметки Markdown. | ||
|
|
||
| Шаблон для страниц: | ||
|
|
||
| ``` | ||
| # Название страницы | ||
| ### Название кодировки/адаптации | ||
| !!! tip "" | ||
| Описание/Цель, если есть | ||
| !!! warning "" | ||
| Предупреждение, если есть | ||
| ``` yaml title="логин-пароль: XXXXX (если есть)" | ||
| Блок XX → Адаптация/Кодирование: | ||
| Байт XX – Бит X (название бита): Активировать | ||
| Название раздела: | ||
| - Название адаптации: Активировать | ||
| → Применить | ||
| ``` | ||
| ??? note "Название раскрывающегося списка" | ||
| Здесь находится информация, которая по умолчанию на сайте отображается свернутой | ||
| ``` | ||
|
|
||
| Пример вставки изображений на страницу сайта: | ||
| `````` | ||
|
|
||
| Пример вставки файлов на страницу сайта: | ||
| ```[(Сборка для Skoda)](../firmwares/TMC-zz.rar)``` |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| mkdocs-material==9.5.1 | ||
| mkdocs-material==9.5.2 | ||
| mkdocs-print-site-plugin==2.3.6 | ||
| mkdocs-static-i18n==1.2.0 | ||
| mkdocs-git-revision-date-localized-plugin==1.2.1 |