Axialix Wiki¶

О проекте¶

Автор: Axialix. Вики хранит технические заметки, собирается mkdocs build и отдаётся через Caddy.

Синтаксис и примеры¶

Заголовки, списки, ссылки¶

Контент лежит в docs/, внутренние ссылки ведём без расширения.

Подзаголовок H4¶

Маркёр
Ещё
Первый
Второй

Ссылка на раздел макросов
Материал

Иконки и эмодзи¶

Иконки темы через :material-...:, эмодзи — стандартные.

и

Подсказки¶

Добавляем атрибут data-tooltip после элемента.

Наведи на слово подсказка{: data-tooltip="Всплывающий текст" }.

Сноски¶

Определения внизу секции.

Текст со сноской[^demo].

[^demo]: Пример сноски.

Admonitions¶

Используем блоки !!! и сворачиваемые ???.

Note

Примечание.

Tip

Совет.

Warning

Предупреждение.

Подробнее

Скрыто по умолчанию.

Подсветка кода¶

pymdownx.highlight поддерживает аннотации (1)!.

echo "hello"  # (1)!

Вывод строки.

key: value  # (1)!

Пара ключ‑значение.

Вкладки¶

pymdownx.tabbed формирует платформенные блоки.

Linux

uname -a

Windows

Get-ChildItem

Docker

docker ps

Таблицы¶

Обычный Markdown; внешний вид задаёт CSS.

Команда	Назначение
build	Сборка
serve	Локальный сервер

Чек‑листы¶

Плагин tasklist рисует кастомные чекбоксы.

Сделано
Осталось

GLightbox¶

Изображения кладём в docs/images/, одинаковый { data-gallery="" } собирает в одну группу.

Mermaid¶

Диаграммы в блоках с языком mermaid.

flowchart LR
  A --> B

sequenceDiagram
  participant A
  participant B
  A->>B: Ping
  B-->>A: Pong

Snippets¶

Файлы подключаются --8<-- "path", путь относителен docs/.

Macros¶

mkdocs-macros-plugin берёт контекст из mkdocs.yml и macros.py.

Текущий сайт: Axialix Wiki (https://wiki.axialix.ru/).

Inline HTML¶

HTML допустим, атрибут markdown включает рендер Markdown внутри.

Логотип

Центрированный текст