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

Установка MkDocs-Material

Установка может быть выполнена несколькими способами. Здесь описаны они все, а вы самостоятельно решите, какой из них применить в вашей ситуации.

Установка при помощи pip

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

Если в вашей системе не установлен Python и модуль venv, установите их:

apt install pip python3-venv

Создайте директорию для будущего проекта и перейдите в нее:

mkdir src
cd src

Создайте виртуальное окружение с именем mkdocs_material (имя можете задать свое) и активируйте его:

python3 -m venv mkdocs_material
source mkdocs_material/bin/activate

Установите MkDocs-Material при помощи pip:

pip install mkdocs-material

Создайте директорию для будущего сайта

mkdir data
cd data

Сформируйте начальных шаблон данных для генератора сайта:

mkdocs new .

Добавьте в файл конфигурации mkdocs.yml минимальную конфигурацию сайта:

site_name: My site
theme:
  name: material

Запустите отладочный веб-сервер с сайтом (здесь также указана опция прослушивания всех сетевых интерфейсов и определенного порта):

mkdocs serve -a 0.0.0.0:8080

Установка при помощи Docker

...

Установка из Github

...

Установка из репозиториев Linux

...