Перейти к содержанию

Первая заметка о настройке

Это тестовая страница, созданная для проверки работы документации.

Базовое форматирование

Жирный шрифт, курсив, ~~зачёркнутый текст~~ и встроенный код.

Ссылка: официальная документация MkDocs.

Блок кода

# Пример команды для сборки сайта
mkdocs build

Цитаты и вставки

Примечание: Тема Material поддерживает специальные блоки для примечаний.

!!! note "Полезный совет" Если вам нужно выделить важную информацию, используйте блок note.

!!! warning "Осторожно" Блок warning предупредит читателя о возможных проблемах.

Маркированный список

  • Простота
  • Гибкость
  • Скорость

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

  1. Создайте файл Markdown.
  2. Добавьте его в навигацию.
  3. Пересоберите сайт.

Вложенный список

  • Основные разделы:
    • Введение
    • Настройка
    • Примеры
  • Дополнительные материалы:
    • Часто задаваемые вопросы
    • Ссылки на ресурсы

Чек-лист

  • [x] Установить MkDocs и тему Material
  • [x] Настроить mkdocs.yml
  • [ ] Создать первую запись
  • [ ] Проверить отображение на мобильных устройствах

Простая таблица

Параметр Значение
Язык Markdown
Генератор MkDocs
Тема Material

Таблица с выравниванием

Элемент Описание Статус
Заголовки Используются для структуры Готово
Списки Упрощают перечисление Готово
Таблицы Наглядно представляют данные Готово
Изображения Добавляются позже В плане

Таблица с форматированием внутри ячеек

Команда Назначение Пример использования
mkdocs new Создаёт новый проект mkdocs new my-project
mkdocs build Собирает статический сайт mkdocs build
mkdocs serve Запускает локальный сервер mkdocs serve --dev-addr=0.0.0.0:8000

Заключение

Эта страница — лишь начало. Экспериментируйте с разметкой.