mkdocs-material: bash pip install mkdocs-material
Затем создайте конфигурационный файл mkdocs.yml
для вашего проекта: yaml site_name: 'Имя вашего сайта' theme: 'material' # Определение папок nav: - Домой: index.md - Установка: installation.md - Использование: usage-guide.md # Настройки темы material extra: социальные сети: - иконка: fontawesome/fontawesome-brands/github-square ссылка: https://github.com/ваш_проект
Создайте необходимые страницы в вашем каталоге документов, используя Markdown (index.md
, installation.md
, usage-guide.md
). Вы можете запустить локальный сервер для просмотра ваших документов командой: bash mkdocs serve
Это позволит вам просмотреть сайт на http://localhost:8000 и работать над ним до тех пор, пока вы полностью довольны результатом. Когда вы закончите работу над сайтом, вы сможете создать версию для развертывания командой: bash mkdocs build --clean
Это создаст все необходимые файлы в директории site/
. Вы можете затем разместить эти файлы на любом сайте, который поддерживает статический контент. Обратите внимание, что это базовый пример использования mkdocs-material. Тема предоставляет множество других возможностей для настройки внешнего вида и поведения вашего сайта документации.
Предоставленная информация не содержит текста для перевода. Чтобы выполнить задачу, пожалуйста, предоставьте конкретный текст или фрагменты текста, которые требуется перевести.
Вход Перед тем как оставить комментарий