MkDocs
MkDocs - это инструмент, разработанный в Python для создания сайтов статической документации на основе файлов Markdown.
Обзор
MkDocs - очень популярный инструмент с огромным сообществом. В нем есть несколько тем для создания веб-сайтов; несколько plugins для расширения основных функций программы и понятная документация.
MkDocs - это проект с открытым исходным кодом, разработанный Python.
Приложение использует процессор Markdown Python-Markdown, обеспечивающий очень хорошую поддержку основных элементов синтаксиса, однако совместимость с элементами расширенного синтаксиса оставляет желать лучшего.
Стоит отметить, что, поскольку MkDocs использует Python-Markdown, можно активировать дополнительные расширения, чтобы изменить поведение парсера, щелкните здесь, чтобы просмотреть список доступных расширений, совместимых с Python-Markdown.
Дополнительную информацию можно найти на официальном сайте MkDocs https://www.mkdocs.org/.
Использование Admonitions на MkDocs
Расширение Admonitions позволяет отображать стилизованные сообщения пользователей на вашей странице на веб-сайтах, созданных с помощью MkDocs.
Для получения дополнительной информации и примеров см. та страница на GitHub.
Поддержка Markdown на MkDocs
Таблица 1.1 представляет элементы Markdown, совместимые с MkDocs.
| Элемент | Поддерживать | Информация |
|---|---|---|
| Титулы | Да | |
| Абзацы | Да | |
| Разрывы строк | Да | |
| Смелый | Да | |
| Курсив | Да | |
| Blockquote | Да | |
| Упорядоченные списки | Да | |
| Неупорядоченные списки | Да | |
| Код | Да | |
| Горизонтальные линии | Да | |
| Links | Да | |
| Изображений | Да | |
| Столы | Да | |
| Огороженные блоки кода | Да | Есть возможность выделить синтаксис содержимого блока. |
| Сноски | Нет | |
| Идентификатор заголовка | Нет | |
| Списки определений | Нет | |
| Зачеркнутый | Нет | |
| Списки задач | Нет | |
| Emoji (скопировать и вставить) | Да | По умолчанию он не поддерживается, но вы можете включить расширение для использования этого элемента Markdown. |
| Emoji (коды доступа) | Да | MkDocs по умолчанию не поддерживает коды emoticons, но вы можете установить расширение для форматирования содержимого с помощью этого элемента Markdown. |
| автоматический Link от URL | Да | |
| Отключить автоматический link URL | Да | |
| HTML | Да |