Обновить 'readme.md'
This commit is contained in:
parent
70287ff30a
commit
5cdf802da7
44
readme.md
44
readme.md
|
@ -1,7 +1,45 @@
|
|||
# MkDocs
|
||||
## Инструкция по установке есть на сайте MkDocs.
|
||||
|
||||
### Надо установить:
|
||||
|
||||
python python.org
|
||||
pip – менеджер пакет (ставится, обычно, вместе с питоном)
|
||||
mkdocs – пакет с движком mkdocs
|
||||
|
||||
`pip install mkdocs`
|
||||
Полезные ссылки:
|
||||
|
||||
mkdocs.org
|
||||
|
||||
### плагины MkDocs
|
||||
|
||||
Темы MkDocs
|
||||
|
||||
markdown дополнения
|
||||
|
||||
Тема
|
||||
В проекте используется тема material.
|
||||
|
||||
Для установки запускаем:
|
||||
|
||||
`pip install mkdocs-material`
|
||||
Полезные ссылки:
|
||||
|
||||
Настройки темы material
|
||||
Плагины из темы material
|
||||
Проект темы material на GitHub
|
||||
Плагины
|
||||
В проекте используются плагины:
|
||||
|
||||
search – встроенный плагин поиска.
|
||||
img2fig – отображение картинок в отдельном теге с подписью внизу.
|
||||
pip install mkdocs-img2fig-plugin
|
||||
|
||||
Для разработки и проверки документации можно использовать команды
|
||||
* mkdocs serve (с созданием pdf файлов)
|
||||
* mkdocs serve -f dev.yml (без создания pdf файлов)
|
||||
* mkdocs build -f admin-manuals.yml (с созданием pdf файла с инструкциями для администратора)
|
||||
* `mkdocs serve` (с созданием pdf файлов)
|
||||
* `mkdocs serve -f dev.yml` (без создания pdf файлов)
|
||||
* `mkdocs build -f admin-manuals.yml` (с созданием pdf файла с инструкциями для администратора)
|
||||
|
||||
Перед запуском надо установить mkdocs и его расширения. Сделать это можно при помощи команды, запущенной в папке mkdocs
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue