Ga naar hoofdinhoud
50% korting alle plannen, beperkte tijd. Vanaf $2.48/mo
MkDocs

MkDocs

MkDocs maakt van een map met Markdown een documentatiesite op basis van één YAML-configuratiebestand. Het levert een dev-server met live reload en bouwt gewone statische HTML die u overal kunt hosten. BSD-2-Clause-licentie met meer dan 22.300 GitHub-sterren.

In een oogopslag

22.4k

GitHub-sterren

1

Paginaweergaven

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

Toegang

  • Open: http://SERVER_IP

Inhoud bewerken en publiceren

1. Voeg Markdown-bestanden toe of bewerk ze: /opt/mkdocs/docs

2. Als u pagina's toevoegt of hernoemt, werk dan /opt/mkdocs/mkdocs.yml for navigation.

3. Bouw de site opnieuw:

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

Nginx levert de gegenereerde bestanden uit: /opt/mkdocs/site

Na het opnieuw bouwen hoeft Nginx niet te worden herstart.

Belangrijke paden

  • Project: /opt/mkdocs
  • Inhoud: /opt/mkdocs/docs
  • Configuratie: /opt/mkdocs/mkdocs.yml
  • Build-uitvoer: /opt/mkdocs/site
  • Python-virtualenv: /opt/mkdocs/venv
  • Uitvoerbaar bestand van MkDocs: /opt/mkdocs/venv/bin/mkdocs
  • Nginx-configuratie: /etc/nginx/sites-available/mkdocs.conf

Domein en HTTPS

1. Laat uw domein naar het IP-adres van de server wijzen.

2. Bewerk de Nginx-configuratie en vervang server_name _; door uw domein (bijvoorbeeld server_name <YOUR_DOMAIN>;):

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

3. Test de configuratie:

nginx -t

4. Installeer Certbot:

apt install -y certbot python3-certbot-nginx

5. Genereer een Let's Encrypt-certificaat:

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

6. Herlaad Nginx:

systemctl reload nginx

7. Werk de MkDocs-site-URL bij: vervang site_url: 'http://<SERVER_IP>/' door site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Bouw de site opnieuw:

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

9. Open je browser en bezoek: https://<YOUR_DOMAIN>

Opmerkingen

  • Markdown-wijzigingen moeten opnieuw worden gebouwd voordat ze op de publieke site verschijnen.
  • Nginx serves the generated files from /opt/mkdocs/site.
  • Wijzig mkdocs.yml en de projectconfiguratie naar uw voorkeuren.

Meer in Development-tools

Gerelateerde apps.

Deploy MkDocs nu. Vanaf $2,48/mnd.