Социальная сеть "Точка"

Документация: https://rexandel.github.io/point

Как работать с документацией

• Все файлы документации лежат в папке point-docs/docs/.
• Редактируйте .md файлы.
• Сохраняйте изменения в main ветку - сайт обновится сам через некоторое время.

Как запустить документацию локально

0. Установите Python 3.8+:

   Официальный сайт: https://www.python.org.

1. Скачайте проект:

git clone https://github.com/rexandel/point.git

cd point

3. Перейдите в папку с документацией:

cd point-docs

4. Создайте виртуальное окружение:

python -m venv venv

5. Активируйте виртуальное окружение:

   Windows: venv\Scripts\activate
   Mac/Linux: source venv/bin/activate

6. Установите нужные пакеты:

pip install mkdocs mkdocs-material

7. Запустите сервер для просмотра документации:

mkdocs serve

8. Откройте документацию в браузере: http://127.0.0.1:8000.