mkdocs

MkDocs

Dokumentasi proyek dengan Markdown

MkDocs adalah generator situs statis yang cepat , sederhana dan cantik yang diarahkan untuk membangun dokumentasi proyek. File sumber dokumentasi ditulis dalam Markdown, dan dikonfigurasi dengan satu file konfigurasi YAML. Ini dirancang agar mudah digunakan dan dapat diperluas dengan tema pihak ketiga, plugin, dan ekstensi Markdown.

Silakan lihat Dokumentasi untuk tutorial pengantar dan panduan pengguna lengkap.

Fitur

• Buat file HTML statis dari file Markdown.
• Gunakan Plugin dan Ekstensi Penurunan Harga untuk menyempurnakan MkDocs.
• Gunakan tema bawaan, tema pihak ketiga, atau buat tema Anda sendiri.
• Publikasikan dokumentasi Anda di mana pun file statis dapat disajikan.
• Lebih banyak lagi!

Mendukung

Jika Anda memerlukan bantuan dengan MkDocs, jangan ragu untuk menghubungi kami!

• Untuk pertanyaan dan diskusi tingkat tinggi, gunakan Diskusi di GitHub.
  • Untuk pertanyaan kecil, alternatif yang baik adalah ruang Obrolan di Gitter/Matrix.
• Untuk melaporkan bug atau membuat permintaan fitur, buka Masalah di GitHub.

Harap dicatat bahwa kami hanya dapat memberikan dukungan untuk masalah/pertanyaan mengenai fitur inti MkDocs. Setiap pertanyaan atau laporan bug tentang fitur tema pihak ketiga, plugin, ekstensi atau sejenisnya harus disampaikan pada proyek masing-masing.
Namun, pertanyaan seperti itu tidak dilarang di ruang obrolan.

Pastikan untuk tetap menjawab beberapa pertanyaan juga!

Tautan

• Dokumentasi Resmi
• Catatan Rilis Terbaru
• Katalog plugin, tema, dan resep pihak ketiga

Berkontribusi pada MkDocs

Proyek MkDocs menyambut baik, dan bergantung pada, kontribusi dari pengembang dan pengguna di komunitas sumber terbuka. Silakan lihat Panduan Berkontribusi untuk informasi tentang bagaimana Anda dapat membantu.

Kode Etik

Setiap orang yang berinteraksi dalam basis kode, pelacak isu, dan forum diskusi proyek MkDocs diharapkan mengikuti Kode Etik PyPA.

Lisensi

BSD-2-Klausul