Быстрый старт

Этот раздел поможет вам начать работу с проектом за 5 минут. Здесь описаны два способа: локальная установка через Python и сборка через Docker.

Предварительные требования

Инструмент	Версия	Проверка
Python	3.9+	`python --version`
pip	21.0+	`pip --version`
Docker	20.0+	`docker --version`
Git	2.30+	`git --version`

Способ 1. Локальная установка через Python

Шаг 1. Клонируйте репозиторий

git clone https://gitverse.ru/profdefence/docs-as-code-portfolio.git
cd docs-as-code-portfolio

Шаг 2. Создайте виртуальное окружение

python3 -m venv venv
source venv/bin/activate

Шаг 3. Установите зависимости

pip install -r requirements.txt

Шаг 4. Запустите локальный сервер

mkdocs serve

Документация будет доступна по адресу: http://localhost:8000

Способ 2. Сборка через Docker

Этот способ не требует установки Python и всех зависимостей — всё уже упаковано в Docker-образ.

Шаг 1. Соберите Docker-образ

docker build -t docs-portfolio .

Шаг 2. Запустите локальный сервер

docker run --rm -p 8000:8000 -v $(pwd):/app docs-portfolio

Откройте браузер и перейдите по адресу: http://localhost:8000

Шаг 3. Соберите статический сайт

docker run --rm -v $(pwd):/app docs-portfolio build

Готовый сайт появится в папке site/.

Что дальше?

Руководство по установке — более детальная инструкция.
Руководство по настройке — конфигурация системы.
Руководство по интеграции — подключение внешних сервисов.
Устранение неполадок — решение частых проблем.
API Reference — документация REST API.
Стайлгайд — правила оформления документации.

Нужна помощь?

Email: profdefence@mail.ru
Telegram: @Dmilkoff