Přejít na hlavní obsah
Sleva 50% všechny plány, omezený čas. Od $2.48/mo
MkDocs

MkDocs

MkDocs promění složku s Markdownem v dokumentační web pomocí jediného konfiguračního souboru YAML. Přináší vývojový server s live reloadem a generuje čisté statické HTML, které nahostujete kdekoli. Licence BSD-2-Clause a více než 22 300 hvězd na GitHubu.

Na první pohled

22.4k

Hvězdičky na GitHubu

1

Zobrazení stránky

Licence BSD-2-Clause Verze Latest OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV4,IPV6

Přístup

  • Otevřete: http://SERVER_IP

Úprava a publikování obsahu

1. Přidejte nebo upravte soubory Markdown: /opt/mkdocs/docs

2. Pokud přidáte nebo přejmenujete stránky, upravte /opt/mkdocs/mkdocs.yml for navigation.

3. Znovu sestavte web:

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

Nginx servíruje vygenerované soubory z: /opt/mkdocs/site

Po znovusestavení není nutné restartovat Nginx.

Důležité cesty

  • Projekt: /opt/mkdocs
  • Obsah: /opt/mkdocs/docs
  • Konfigurace: /opt/mkdocs/mkdocs.yml
  • Výstup buildu: /opt/mkdocs/site
  • Virtuální prostředí Pythonu: /opt/mkdocs/venv
  • Spustitelný soubor MkDocs: /opt/mkdocs/venv/bin/mkdocs
  • Konfigurace Nginx: /etc/nginx/sites-available/mkdocs.conf

Domény a HTTPS

1. Nasměrujte svou domény na IP adresu serveru.

2. Upravte konfiguraci Nginx a nahraďte server_name _; svou doménou (například server_name <YOUR_DOMAIN>;):

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

3. Otestujte konfiguraci:

nginx -t

4. Nainstalujte Certbot:

apt install -y certbot python3-certbot-nginx

5. Vygenerujte certifikát Let's Encrypt:

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

6. Znovu načtěte Nginx:

systemctl reload nginx

7. Aktualizujte URL webu MkDocs: nahraďte site_url: 'http://<SERVER_IP>/' za site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Znovu sestavte web:

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

9. Otevři prohlížeč a přejdi na: https://<YOUR_DOMAIN>

Poznámky

  • Změny v Markdownu je nutné znovu sestavit, než se objeví na veřejném webu.
  • Nginx serves the generated files from /opt/mkdocs/site.
  • Změňte mkdocs.yml a konfiguraci projektu podle svých preferencí.

Více ve vývojářských nástrojích

Související aplikace.

Nasaďte MkDocs hned. Od 2,48 $/měs.