Ugrás a fő tartalomra
50% kedvezmény minden csomagra, korlátozott ideig. Már $2.48/mo
MkDocs

MkDocs

A MkDocs egyetlen YAML konfigurációs fájl alapján dokumentációs oldallá alakít egy Markdown-mappát. Élő újratöltésű fejlesztői szervert ad, és sima statikus HTML-t épít, amit bárhol elhelyezhet. BSD-2-Clause licenc, több mint 22 300 GitHub-csillag.

Egy pillantásra

22.4k

GitHub-csillagok

1

Oldalmegtekintések

Licenc BSD-2-Clause Verzió Latest OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV4,IPV6

Hozzáférés

  • Nyissa meg: http://SERVER_IP

Tartalom szerkesztése és közzététele

1. Adjon hozzá vagy szerkesszen Markdown-fájlokat: /opt/mkdocs/docs

2. Ha oldalakat ad hozzá vagy átnevez, frissítse ezt: /opt/mkdocs/mkdocs.yml for navigation.

3. Építse újra az oldalt:

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

Az Nginx innen szolgálja ki a generált fájlokat: /opt/mkdocs/site

Az újraépítés után nem kell újraindítani az Nginx-et.

Fontos útvonalak

  • Projekt: /opt/mkdocs
  • Tartalom: /opt/mkdocs/docs
  • Konfiguráció: /opt/mkdocs/mkdocs.yml
  • Build kimenete: /opt/mkdocs/site
  • Python virtuális környezet: /opt/mkdocs/venv
  • MkDocs futtatható fájl: /opt/mkdocs/venv/bin/mkdocs
  • Nginx-konfiguráció: /etc/nginx/sites-available/mkdocs.conf

Domain és HTTPS

1. Irányítsa a domainjét a szerver IP-címére.

2. Szerkessze az Nginx konfigurációját, és cserélje ki ezt: server_name _; a saját domainjére (például server_name <YOUR_DOMAIN>;):

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

3. Tesztelje a konfigurációt:

nginx -t

4. Telepítse a Certbotot:

apt install -y certbot python3-certbot-nginx

5. Hozzon létre egy Let's Encrypt tanúsítványt:

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

6. Töltse újra az Nginx-et:

systemctl reload nginx

7. Frissítse a MkDocs oldal URL-jét: cserélje ki ezt: site_url: 'http://<SERVER_IP>/' erre: site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Építse újra az oldalt:

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

9. Nyissa meg a böngészőjét és látogassa meg: https://<YOUR_DOMAIN>

Megjegyzések

  • A Markdown-változásokat újra kell építeni, mielőtt megjelennének a nyilvános oldalon.
  • Nginx serves the generated files from /opt/mkdocs/site.
  • Módosítsa mkdocs.yml és a projekt konfigurációját a saját igényei szerint.

Több a Fejlesztői eszközök kategóriában

Kapcsolódó alkalmazások.

MkDocs telepítése most. Már 2,48 $/hó-tól.