Gå til hovedindhold
50% rabat alle planer, tidsbegrænset. Fra $2.48/mo
MkDocs

MkDocs

MkDocs forvandler en mappe med Markdown til et dokumentationssite ud fra én YAML-konfigurationsfil. Den leverer en dev-server med live reload og bygger almindelig statisk HTML, du kan hoste hvor som helst. BSD-2-Clause-licens med over 22.300 GitHub-stjerner.

Overblik

22.4k

GitHub-stjerner

1

Sidevisninger

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

Adgang

  • Åbn: http://SERVER_IP

Rediger og udgiv indhold

1. Tilføj eller rediger Markdown-filer: /opt/mkdocs/docs

2. Hvis du tilføjer eller omdøber sider, skal du opdatere /opt/mkdocs/mkdocs.yml for navigation.

3. Byg sitet igen:

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

Nginx leverer de genererede filer fra: /opt/mkdocs/site

Nginx behøver ikke genstart efter en ny build.

Vigtige stier

  • Projekt: /opt/mkdocs
  • Indhold: /opt/mkdocs/docs
  • Konfiguration: /opt/mkdocs/mkdocs.yml
  • Build-output: /opt/mkdocs/site
  • Python-virtualenv: /opt/mkdocs/venv
  • MkDocs-programfil: /opt/mkdocs/venv/bin/mkdocs
  • Nginx-konfiguration: /etc/nginx/sites-available/mkdocs.conf

Domæne og HTTPS

1. Peg dit domæne mod serverens IP-adresse.

2. Rediger Nginx-konfigurationen og erstat server_name _; med dit domæne (for eksempel server_name <YOUR_DOMAIN>;):

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

3. Test konfigurationen:

nginx -t

4. Installer Certbot:

apt install -y certbot python3-certbot-nginx

5. Generer et Let's Encrypt-certifikat:

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

6. Genindlæs Nginx:

systemctl reload nginx

7. Opdater MkDocs-sitets URL: erstat site_url: 'http://<SERVER_IP>/' med site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Byg sitet igen:

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

9. Åbn din browser og gå til: https://<YOUR_DOMAIN>

Bemærkninger

  • Markdown-ændringer skal bygges igen, før de vises på det offentlige website.
  • Nginx serves the generated files from /opt/mkdocs/site.
  • Ændr mkdocs.yml og projektkonfigurationen efter dine præferencer.

Mere i Udviklingsværktøjer

Relaterede apps.

Deploy MkDocs nu. Fra 2,48 $/md.