Skip to content

Оставь надежду, всяк сюда входящший

Как склонировать и запустить доку

  1. Склонировать репозиторий
  2. Установить зависимости
  3. Запустить локальный сервер
git clone git@github.com:LDocsSite/Documentation.git // Клонируем репу к себе на пк
cd Documentation // Переходим в папку с репозиторием
pip3 install mkdocs-material // Установка самого MkDocs
python3 -m mkdocs serve // Запуск локально

Процесса билда и пуша изменений:
1. python3 -m mkdocs gh-deploy --force //Пуш в репозиторий с автоматическим билдом
2. git add .
3. git commit -am "сообщение коммита"
4. git push origin main

Примеры важных обозначений

Заголовок

Синий. Общая заметка.

Заголовок

Синий. Информация.

Заголовок

Зелёный. Полезный совет.

Заголовок

Зелёный. Успех / готово.

Заголовок

Оранжевый. Предупреждение.

Заголовок

Красный. Опасно / критично.

Заголовок

Фиолетовый. Пример.

Заголовок

Серый. Цитата.