KirishAkkaunt yaratish
KirishAkkaunt yaratish

mkdocs

Ochiq manbalardan

MkDocs — loyiha hujjatlarini Markdown fayllaridan yaratish uchun ochiq manbali CLI statik sayt generatori, bitta YAML fayl orqali sozlanadi.

CLI vositaKategoriya: Dasturchi vositalari · HujjatlashtirishOpen sourcemaʼlumot tekshirilgan: 15-okt, 2026
SolishtirishToʻplamga

Sharh

Loyiha hujjatlari ko‘pincha vikilar, README fayllari va alohida sahifalar o‘rtasida tarqalib ketadi va ularni dolzarb holatda saqlash qiyin bo‘ladi. MkDocs bu muammoni oddiy Markdown manba fayllarini statik HTML hujjatlar saytiga aylantirish orqali hal qiladi; sayt bitta YAML fayl bilan sozlanadi. MkDocs uchinchi tomon mavzulari, plaginlari va Markdown kengaytmalari bilan kengaytirilishi mumkin, shuningdek tayyor o‘rnatilgan mavzularga ega. Natija oddiy statik fayllar bo‘lib, ularni statik fayllar uzatiladigan istalgan joyda nashr etish mumkin. MkDocs hujjatlarni kod bilan birga yuritmoqchi bo‘lgan dasturchilar va texnik muharrirlar uchun mo‘ljallangan. U Python tilida yozilgan, BSD-2-Clause litsenziyasi ostida tarqatiladi va buyruq satridan ishlatiladi.
  • documentation
  • knowledge-base
  • markdown
  • mkdocs
  • python
  • static-site-generator

Oʻrnatish

Buyruqlar faqat koʻrsatiladi, marketpleys ularni bajarmaydi. Rasmiy hujjatlar bilan solishtiring.
  • Rasmiy saytOchiq manbalardankatalog metamaʼlumotlaridan
    www.mkdocs.org/ ↗
  • Til paketlari reyestripythonOchiq manbalardanpaket manifestidan — reyestrda chop etilgani tekshirilmagan
    pipx install mkdocs

    Tekshirilmagan: oʻrnatishdan oldin reyestrdagi paket aynan shu loyihaga tegishli ekanini tekshiring.

    pypi.org/project/mkdocs/ ↗
  • Manbadan yigʻishOchiq manbalardankatalog metamaʼlumotlaridan

    Manbadan yigʻish: tekshirilgan yigʻish retsepti yoʻq — repozitoriy koʻrsatmalariga amal qiling.

    github.com/mkdocs/mkdocs ↗

Moslik

«Nomaʼlum» dalil topilmaganini bildiradi, mahsulot mos emasligini emas.
PlatformaHolatArxitekturaDalilIshonchlilik
WindowsNomaʼlum———
macOSNomaʼlum———
LinuxNomaʼlum———
Container (OCI)Nomaʼlum———
Web browserMos—Kartochkada bildirilgan—
PythonMos—paket manifesti: pyproject.toml name0.60

Relizlar

tekshirilgan: 29-okt, 2026
v1.6.1Oxirgi30-avg, 2024Rasmiy manba ↗

1.6.1 versiyasi fayllari

Relizga fayllar biriktirilmagan.

Relizlar tarixi

Sifat profili

algoritm quality-v1.0 · baholangan 15-okt, 2026
Sifat bahosi73
Xavf bahosi0
Ishonchlilik 1.00
Sifat bahosi va xavf bahosi — turli koʻrsatkichlar. Yuqori sifat xavfsizlikni kafolatlamaydi.

Baho tarkibi

Qoʻllab-quvvatlash · 206
last activity 360 days ago
Hujjatlar · 1515
README 3117 chars, description present
Foydalanishga tayyorlik · 156
install instructions: no; releases: yes
Metamaʼlumotlar · 1010
4/4 of description, homepage, license, topics
Relizlar · 106
10 release(s), latest 776 days ago
Kategoriya aniqligi · 1010
classifier confidence 1
Ommaboplik · 1010
22501 stars (log-dampened, 10k = max)
Litsenziya aniqligi · 55
SPDX BSD-2-Clause
Hamjamiyat · 55
issues enabled, 2657 forks

Litsenziya

BSD-2-Clause
Litsenziya maʼlumrepozitoriy xostingi maʼlumotlariga koʻra

Bu katalog siyosati holati, yuridik xulosa emas.

Manbalar

github.com/mkdocs/mkdocsAsosiy★ 22 501 yulduzfaollik: 20-okt, 2025Asosiy repozitoriy · Ishonchlilik 1.00

Sharhlar

Sharh yozish uchun kiring

Hali sharhlar yoʻq.

Muqobillar

mkdocs-materialOʻxshash
Material for MkDocs — MkDocs uchun ochiq manbali mavzu va freymvork bo‘lib, Markdown fayllarni qidiruvga ega, moslashuvchan statik hujjatlar saytiga aylantiradi.MIT · Dasturchi vositalari
docsifyOʻxshash
Docsify — Markdown fayllarini build bosqichisiz hujjatlar saytiga aylantiruvchi ochiq kodli CLI generator, Developer Tools toifasidagi loyihalar uchun.MIT · Dasturchi vositalari
vitepressOʻxshash
VitePress — Vue va Vite asosidagi ochiq kodli statik sayt generatori boʻlib, Markdown’dan tez hujjat saytlari yaratish uchun moʻljallangan.MIT · Dasturchi vositalari
docusaurusOʻxshash
Docusaurus — dasturiy loyihalar uchun hujjat saytlarini yaratish, joylashtirish va qoʻllab-quvvatlash uchun ochiq manbali CLI va React asosidagi freymvork.MIT · Dasturchi vositalari
OCRmyPDFOʻxshash
OCRmyPDF — skanerlangan PDF fayllarga qidiriladigan OCR matn qatlamini qoʻshadigan, ochiq kodli buyruq satri vositasi.MPL-2.0 · Dasturchi vositalari
reflexOʻxshash
🕸️ Sof Python’da veb-ilovalar 🐍Apache-2.0 · Dasturchi vositalari

README

mkdocs/mkdocs dan · litsenziya BSD-2-Clause · yuklangan 29-okt, 2026

MkDocs

Project documentation with Markdown

[PyPI Version] [Build Status] [Coverage Status]

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions.

Please see the Documentation for an introductory tutorial and a full user guide.

Features

  • Build static HTML files from Markdown files.
  • Use Plugins and Markdown Extensions to enhance MkDocs.
  • Use the built-in themes, third party themes or create your own.
  • Publish your documentation anywhere that static files can be served.
  • Much more!

Support

If you need help with MkDocs, do not hesitate to get in contact with us!

  • For questions and high-level discussions, use Discussions on GitHub.
    • For small questions, a good alternative is the Chat room on Gitter/Matrix.
  • To report a bug or make a feature request, open an Issue on GitHub.

Please note that we may only provide support for problems/questions regarding core features of MkDocs. Any questions or bug reports about features of third-party themes, plugins, extensions or similar should be made to their respective projects.
But, such questions are not banned from the chat room.

Make sure to stick around to answer some questions as well!

Links

Contributing to MkDocs

The MkDocs project welcomes, and depends on, contributions from developers and users in the open source community. Please see the Contributing Guide for information on how you can help.

Code of Conduct

Everyone interacting in the MkDocs project's codebases, issue trackers, and discussion forums is expected to follow the PyPA Code of Conduct.

License

BSD-2-Clause

Repozitoriyni ochish ↗