Ana içeriğe geç
%50 indirim tüm planlarda, sınırlı süreyle. Başlangıç fiyatı $2.48/mo
MkDocs

MkDocs

MkDocs, tek bir YAML yapılandırma dosyasıyla bir Markdown klasörünü dokümantasyon sitesine dönüştürür. Canlı yeniden yükleme yapan bir geliştirme sunucusu getirir ve her yerde barındırabileceğiniz düz statik HTML üretir. BSD-2-Clause lisanslı, 22.300'den fazla GitHub yıldızı.

Kısaca

22.4k

GitHub yıldızları

1

Sayfa görüntülemeleri

Lisans BSD-2-Clause Sürüm Latest OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV4,IPV6

Erişim

  • Açın: http://SERVER_IP

İçerik düzenleme ve yayınlama

1. Markdown dosyaları ekleyin veya düzenleyin: /opt/mkdocs/docs

2. Sayfa ekler veya yeniden adlandırırsanız şunu güncelleyin: /opt/mkdocs/mkdocs.yml for navigation.

3. Siteyi yeniden derleyin:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

Nginx, üretilen dosyaları şu konumdan sunar: /opt/mkdocs/site

Yeniden derlemeden sonra Nginx'i yeniden başlatmak gerekmez.

Önemli Yollar

  • Proje: /opt/mkdocs
  • İçerik: /opt/mkdocs/docs
  • Yapılandırma: /opt/mkdocs/mkdocs.yml
  • Derleme çıktısı: /opt/mkdocs/site
  • Python sanal ortamı: /opt/mkdocs/venv
  • MkDocs yürütülebilir dosyası: /opt/mkdocs/venv/bin/mkdocs
  • Nginx yapılandırması: /etc/nginx/sites-available/mkdocs.conf

Alan adı ve HTTPS

1. Alan adınızı sunucunun IP adresine yönlendirin.

2. Nginx yapılandırmasını düzenleyip şunu değiştirin: server_name _; kendi alan adınızla (örneğin, server_name <YOUR_DOMAIN>;):

vim /etc/nginx/sites-available/mkdocs.conf

3. Yapılandırmayı test edin:

nginx -t

4. Certbot'u kurun:

apt install -y certbot python3-certbot-nginx

5. Bir Let's Encrypt sertifikası oluşturun:

certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>

6. Nginx'i yeniden yükleyin:

systemctl reload nginx

7. MkDocs site URL'sini güncelleyin: şunu değiştirin: site_url: 'http://<SERVER_IP>/' şununla: site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Siteyi yeniden derleyin:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

9. Tarayıcını aç ve şu adresi ziyaret et: https://<YOUR_DOMAIN>

Notlar

  • Markdown değişikliklerinin herkese açık sitede görünmesi için yeniden derlenmesi gerekir.
  • Nginx serves the generated files from /opt/mkdocs/site.
  • Değiştirin mkdocs.yml ve proje yapılandırmasını tercihlerinize göre değiştirin.

Geliştirme Araçları'nda daha fazlası

İlgili uygulamalar.

MkDocs'yi şimdi dağıtın. 2,48 $/ay'dan başlayan fiyatlarla.