mkdocs

МкДокс

Документация проекта с Markdown

MkDocs — это быстрый , простой и совершенно великолепный генератор статических сайтов, предназначенный для создания проектной документации. Исходные файлы документации написаны в Markdown и настраиваются с помощью одного файла конфигурации YAML. Он прост в использовании и может быть расширен с помощью сторонних тем, плагинов и расширений Markdown.

Пожалуйста, ознакомьтесь с документацией для ознакомительного руководства и полного руководства пользователя.

Функции

• Создавайте статические HTML-файлы из файлов Markdown.
• Используйте плагины и расширения Markdown для улучшения MkDocs.
• Используйте встроенные темы, сторонние темы или создавайте свои собственные.
• Публикуйте свою документацию везде, где можно обслуживать статические файлы.
• Гораздо больше!

Поддерживать

Если вам нужна помощь с MkDocs, не стесняйтесь обращаться к нам!

• Для вопросов и обсуждений высокого уровня используйте «Обсуждения» на GitHub.
  • Для небольших вопросов хорошей альтернативой является чат на Gitter/Matrix.
• Чтобы сообщить об ошибке или отправить запрос на добавление функции, откройте проблему на GitHub.

Обратите внимание, что мы можем оказывать поддержку только по проблемам/вопросам, касающимся основных функций MkDocs. Любые вопросы или сообщения об ошибках, касающиеся функций сторонних тем, плагинов, расширений и т. д., следует направлять в соответствующие проекты.
Но такие вопросы не запрещены в чате.

Обязательно оставайтесь рядом, чтобы ответить на некоторые вопросы!

Ссылки

• Официальная документация
• Последние примечания к выпуску
• Каталог сторонних плагинов, тем и рецептов

Участие в MkDocs

Проект MkDocs приветствует вклад разработчиков и пользователей сообщества открытого исходного кода и зависит от него. Пожалуйста, ознакомьтесь с Руководством для участников, чтобы узнать, как вы можете помочь.

Нормы поведения

Ожидается, что все, кто взаимодействует с базами кода, системами отслеживания проблем и дискуссионными форумами проекта MkDocs, будут следовать Кодексу поведения PyPA.

Лицензия

Пункт BSD-2