МкДокс

МкДокс
Разработчик(и)	Том Кристи, Дугал Мэтьюз, Уэйлан Лимберг, Припин, Ultrabug
Первоначальный выпуск	24 января 2014 г.
Стабильная версия	1.5.3 / 18 сентября 2023 г .; 10 месяцев назад
Репозиторий	github .с /мкдокс /мкдокс ;
Написано в	Питон
Операционная система	Кросс-платформенный
Тип	Генератор документации
Лицензия	БСД
Веб-сайт	www .mkdocs .org

MkDocs — генератор статических сайтов, предназначенный для создания проектной документации . Он написан на Python , а также используется в других средах.

Режим работы

MkDocs преобразует Markdown файлы в HTML- страницы, эффективно создавая статический веб-сайт, содержащий документацию.

Markdown является расширяемым, и экосистема MkDocs использует его расширяемую природу посредством ряда расширений. ^[2]^[3] которые помогают автоматически генерировать документацию из исходного кода, добавлять предостережения, писать математические обозначения, вставлять сноски, выделять исходный код и т. д.

Темы

MkDodcs предоставляет две встроенные темы: тему по умолчанию (на основе Bootstrap ) и тему «Читать документы» . Многие из доступных сторонних тем указаны в официальном каталоге. ^[4] включая популярную тему «Материал для MkDocs». ^[5]

История

Первая тегированная версия MkDocs, версия 0.2, вышла 21 января 2014 года. ^[6]

К началу 2015 года Read the Docs поддерживала сборку документации с помощью MkDocs в дополнение к Sphinx . В рамках подготовки к выпуску 0.12 ^[7] MkDocs начал использовать Read the Docs для хостинга. ^[8]

В январе 2016 года MkDocs добавила поддержку устанавливаемых тем. ^[9] В следующем месяце Мартин Донат приступил к разработке темы «Материал для MkDocs». В последующие годы тема стала очень популярной, и в июле 2020 года модель разработки была изменена на спонсорское программное обеспечение, при котором новые функции сначала выпускаются в версии Insiders и становятся общедоступными после достижения целей финансирования. ^[10]

Использование

MkDocs предлагает встроенную поддержку развертывания на страницах GitHub . Альтернативы, такие как GitLab и Cloudflare Pages, предлагают стороннюю поддержку для развертывания сайтов MkDocs. ^[11]^[12]

Многие компании используют MkDocs с темой Material для развертывания своей документации, включая Atlassian . ^[13] Google , ^[14] Майкрософт , ^[15] и Красная Шапочка . ^[16] Это также популярный выбор среди проектов с открытым исходным кодом, таких как Electron , ^[17] Кубернетес , ^[18] и Вебкит . ^[19]

См. также

Ссылки

^ «Примечания к выпуску» . МкДокс .
^ «Расширения — документация Python-Markdown 3.4.4» . python-markdown.github.io . Проверено 23 сентября 2023 г.
^ «Расширения Pymdown — Документация по расширениям PyMdown» . facelessuser.github.io . Проверено 23 сентября 2023 г.
^ Каталог тем , MkDocs, 23 сентября 2023 г. , получено 23 сентября 2023 г.
^ Донат, Мартин. «Материал для MkDocs» . squidfunk.github.io . Проверено 23 сентября 2023 г.
^ «Выпуск 0.2 · mkdocs/mkdocs» . Гитхаб . Проверено 24 сентября 2023 г.
^ «MkDocs 0.12 уже доступен. Множество исправлений ошибок и несколько новых функций» . X (ранее Twitter) . 14 апреля 2015 г. Проверено 24 сентября 2023 г.
^ «mkdocs | Прочтите документацию» . readthedocs.org . 12 февраля 2015 г. Проверено 24 сентября 2023 г.
^ «Новая версия MkDocs поддерживает устанавливаемые темы. Хорошее дополнение к проекту, которое позволит вам устанавливать через pip» . X (ранее Twitter) . 21 января 2016 г. Проверено 24 сентября 2023 г.
^ Донат, Мартин (27 декабря 2021 г.). «Прошлое, настоящее и будущее – Материал для MkDocs» . squidfunk.github.io . Проверено 24 сентября 2023 г.
^ «Примеры страниц GitLab / mkdocs · GitLab» . ГитЛаб . Проверено 10 декабря 2023 г.
^ «Развертывание сайта MkDocs · Документация Cloudflare Pages» . Developers.cloudflare.com . 07.08.2023 . Проверено 10 декабря 2023 г.
^ «Диаграммы Atlassian DC Helm» . atlassian.github.io . Проверено 10 декабря 2023 г.
^ «Аккомпаниатор» . google.github.io . Проверено 10 декабря 2023 г.
^ «Код с инженерным руководством» . microsoft.github.io . Проверено 10 декабря 2023 г.
^ «домашняя страница — Документация Ansible Lint» . ansible-lint.readthedocs.io . Проверено 10 декабря 2023 г.
^ «электроностроитель» . www.electron.build . Проверено 10 декабря 2023 г.
^ «Добро пожаловать — kOps — Kubernetes Operations» . kops.sigs.k8s.io. Проверено 10 декабря 2023 г.
^ «Документация по WebKit» . docs.webkit.org . Проверено 10 декабря 2023 г.

Внешние ссылки

МкДокс
Docs для совместной работы на базе Sphinx, MkDocs и Jupyter Book. Прочтите масштабный хост документации

[1] «Примечания к выпуску» . МкДокс .

[2] «Расширения — документация Python-Markdown 3.4.4» . python-markdown.github.io . Проверено 23 сентября 2023 г.

[3] «Расширения Pymdown — Документация по расширениям PyMdown» . facelessuser.github.io . Проверено 23 сентября 2023 г.

[4] Каталог тем , MkDocs, 23 сентября 2023 г. , получено 23 сентября 2023 г.

[5] Донат, Мартин. «Материал для MkDocs» . squidfunk.github.io . Проверено 23 сентября 2023 г.

[6] «Выпуск 0.2 · mkdocs/mkdocs» . Гитхаб . Проверено 24 сентября 2023 г.

[7] «MkDocs 0.12 уже доступен. Множество исправлений ошибок и несколько новых функций» . X (ранее Twitter) . 14 апреля 2015 г. Проверено 24 сентября 2023 г.

[8] «mkdocs | Прочтите документацию» . readthedocs.org . 12 февраля 2015 г. Проверено 24 сентября 2023 г.

[9] «Новая версия MkDocs поддерживает устанавливаемые темы. Хорошее дополнение к проекту, которое позволит вам устанавливать через pip» . X (ранее Twitter) . 21 января 2016 г. Проверено 24 сентября 2023 г.

[10] Донат, Мартин (27 декабря 2021 г.). «Прошлое, настоящее и будущее – Материал для MkDocs» . squidfunk.github.io . Проверено 24 сентября 2023 г.

[11] «Примеры страниц GitLab / mkdocs · GitLab» . ГитЛаб . Проверено 10 декабря 2023 г.

[12] «Развертывание сайта MkDocs · Документация Cloudflare Pages» . Developers.cloudflare.com . 07.08.2023 . Проверено 10 декабря 2023 г.

[13] «Диаграммы Atlassian DC Helm» . atlassian.github.io . Проверено 10 декабря 2023 г.

[14] «Аккомпаниатор» . google.github.io . Проверено 10 декабря 2023 г.

[15] «Код с инженерным руководством» . microsoft.github.io . Проверено 10 декабря 2023 г.

[16] «домашняя страница — Документация Ansible Lint» . ansible-lint.readthedocs.io . Проверено 10 декабря 2023 г.

[17] «электроностроитель» . www.electron.build . Проверено 10 декабря 2023 г.

[18] «Добро пожаловать — kOps — Kubernetes Operations» . kops.sigs.k8s.io. Проверено 10 декабря 2023 г.

[19] «Документация по WebKit» . docs.webkit.org . Проверено 10 декабря 2023 г.

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]

[14]

[15]

[16]

[17]

[18]

[19]