В этой статье

Вставка изображений

Форматирование

Заголовок 2 (заголовки внутри статьи)

Основные принципы построения документации HOSTKEY¶

Документация построена на основе проекта MkDocs Material и основана на модифицированной разметке Markdown. Подробная инструкция по элементам оформления доступна тут.

MkDocs Material написан на Python, поэтому в качестве основного форматирующего элемента уровней вы должны использовать табуляцию (клавиша Tab)

Неправильно:

Уровень 1
  Уровень 2
^^
[Пробелы]

Правильно:

Уровень 1
    Уровень 2
^^^^
[Tab]

Вставка изображений¶

По возможности избегаем добавления множества изображений. То есть где возможно описать словами про выбор меню и нажатие кнопок, пишем без вставки картинок. Если же изображения нужны, то следуем следующим правилам.

Изображения размещаем в директории images, которая создается на том же уровне, что и создаваемый .md файл.
Формат изображений: PNG
Изображения одной статьи должны иметь одинаковое начало названия файла. Например для статьи про SSH с названием create_ssh.md, изображения будут расположены и названы так:

-- create_ssh.md
 |
 -images
    |
    - create_ssh_img1.png
    - create_ssh_img2.png
    - create_ssh_test_ssh.png
    ...

Используйте для группового переменования специальные утилиты или файловый менеджер Total Commander (Файлы >> Групповое переименоваение)

Форматирование¶

Полная документация по форматированию в Mkdocs Material тут

Заголовки¶

# Заголовок 1 уровня (название статьи) Заголовок первого уровня один на странице
## Заголовок 2 (заголовки внутри статьи)
### Заголовок 3 уровня
#### Заголовок 4 уровня

Заголовок 2 (заголовки внутри статьи)¶

Заголовок 3 уровня¶

Заголовок 4 уровня¶

Теги¶

Размещаются в начале статьи перед заголовком первого уровня

---
tags:
  - Панели управления сервером
  - Маркетплейс
---

Ссылка¶

[Текст ссылки](URL_ссылки)

Для ссылки на внутренние страницы смотрим в выводе ссылку на нее (со значком "Pi"). Например полный URL http://127.0.0.1:8000/general/docuse/#ссылка, а страница docuse.md, значит ссылка будет такая

[ссылка на раздел Ссылка](docuse.md#ссылка)

ссылка на раздел Ссылка

Изображение¶

![](URL_изображения)

Пункты меню и кнопки в описании программ¶

Пункт меню или интерфейса

**Пункт меню**

Последовательный >> выбор пунктов меню

**Пункт меню 1** >> **Пункт меню 2**

~~Кнопка~~ с названием (если в тексте встречается "нажать кнопку")

~~**Кнопка**~~

Кнопка "Бургер" (три горизонтальные линии)

~~**:fontawesome-solid-bars:**~~

Кнопка "9 точек (grid dots)"

~~**:material-dots-grid:**~~

Кнопка "Три вертикальных точки"

~~**:fontawesome-solid-ellipsis-vertical:**~~

Кнопка "Три горизонтальных точки"

~~**:fontawesome-solid-ellipsis:**~~

Кнопка "Закрытия" (крестик)

~~**:fontawesome-solid-xmark:**~~

Кнопка "Обновить" (стрелки по кругу)

~~**:fontawesome-solid-arrows-rotate:**~~

Кнопка "Плюс" (добавление)

~~**:fontawesome-solid-plus:**~~

Кнопка "Windows"

~~**:fontawesome-brands-windows:**~~

Кнопка "Колокольчик"

~~**:fontawesome-solid-bell:**~~

Значок "Пауза"

==:fontawesome-solid-pause:==

Значок "График"

~~**:fontawesome-regular-chart-bar:**~~

Значок "Глаз" (Scan IP)

~~**:fontawesome-solid-eye:**~~

Значок "Инструменты" (IP settings and DNS RTP management)

~~**:fontawesome-solid-screwdriver-wrench:**~~

Значок "Шестеренка"

~~**:fontawesome-solid-gear:**~~

Значок "Флажок / Чекбокс"

:fontawesome-regular-square-check:

Значки для ссылок на файлы¶

Документы в doc/docx

:fontawesome-solid-file-word: [Название файла](ссылка)

Документы в PDF

:fontawesome-solid-file-pdf: [Название файла](ссылка)

Другие кнопки и значки искать тут.

Кнопки на клавиатуре¶

++ctrl+alt+del++
++esc++
++f6++
++win+x++

Ctrl+Alt+Del

Esc

F6

Win+X

Полный список кнопок искать тут

Теги Invapi¶

:fontawesome-solid-tags: *webpanel*
:fontawesome-solid-tags: *user_name*
:fontawesome-solid-tags: *auto_credit*

webpanel

user_name

auto_credit

Выделенные Блоки (admonitions)¶

Текст в блоке отделяется от края табуляцией. !!! - развернутый блок. ??? - свернутый.

Информационный блок

Информация

Текст информации

!!! info "Информация"
    Текст информации

Блок примечания

Примечание

Текст примечания

!!! note "Примечание"
    Текст примечания

Алерт-блок

Внимание

Текст информации, заслуживающей внимания

!!! warning "Внимание"
    Текст информации, заслуживающей внимания

Успешное завершение действий или команд

Текст об успешном завершении

!!! success ""
    Текст об успешном завершении

Пример (??? - свернутый, !!! - развернутый)

Пример ответа:

Текст примера

??? example "Пример ответа:"
    ```json
    Текст примера
    ```

Пример для API

POST-запрос, cURL

!!! question "POST-запрос, cURL"

    ```bash

    ```

Пример положительного ответа

??? success "Пример положительного ответа"

    ```json

    ```

Пример ответа при ошибке

??? failure "Пример ответа при ошибке"

    ```json

    ```

Блок кода¶

Для Linux (BSD, OsX), cURL

    ```bash
    Код на Bash
    ```

Для Windows

    ```powershell
    Код на Powershell/CMD
    ```

Языки программирования

    ```java
    Код на Java
    ```

Вывод API (JSON)

    ```json
    Текст в формате json
    ```

Список¶

- Маркированный список
- Следующий пункт
    - следующий уровень списка



    - новый пункт следующего уровня

1. Нумерованный список

2. Новый пункт

    ![А это картинка и чтобы не сбилась нумерация ставим с отступом](./image)

    ```bash
    Блок кода
    ```

    !!! info "Информация"
        Текст информации 

3. Еще новый пункт
    - Тут будет маркированный подпункт

        ![А это картинка на втором уровне](./image)

        ```bash
        Блок кода
        ```

        !!! info "Информация"
            Текст информации

    - Новый пункт
4. Снова нумерованный список
    1. А это внутри нумерованного подразделы будут буквами - тут будет `a`
    2. Теперь пункт `b`

Сноски¶

Текст сноски¹.

Текст сноски[^1].

[^1]: Описание сноски.

Экранирование символов¶

Для экранирования символов разметки, добавьте перед ними символ косой строки влево "\"

\*
\#

Для экранирования парных символов, добавьте экран только к закрывающему

<Это текст, ограниченный знаками "больше-меньше" \>

<Это текст, ограниченный знаками "больше-меньше" >

Вкладки¶

Вкладка 1Вкладка 2

Текст вкладки 1

Код во вкладке 2

    === "Вкладка 1"
        Текст вкладки 1

    === "Вкладка 2"
        ```bash
        Код во вкладке 2
        ```

Таблицы¶

Столбец 1	Столбец 2	Столбец 3
Данные 1	Данные 2	Данные 3
Данные 4	Данные 5	Данные 6

| Столбец 1| Столбец 2 | Столбец 3 |
| -------- | --------- | --------- |
| Данные 1 | Данные 2  | Данные 3  |
| Данные 4 | Данные 5  | Данные 6  |

Выравнивание по центру

Столбец 1	Столбец 2	Столбец 3
Д1	Д2	Д3

| Столбец 1| Столбец 2 | Столбец 3 |
| :------: | :-------: | :-------: |
|    Д1    |    Д2     |    Д3     |

Выравнивание по правому краю

Столбец 1	Столбец 2	Столбец 3
Д1	Д2	Д3

| Столбец 1| Столбец 2 | Столбец 3 |
| -------: | --------: | --------: |
|    Д1    |    Д2     |    Д3     |

Ссылка на контрольную панель¶

Invapi

Описание сноски. ↩