Zum Hauptinhalt springen
50 % Rabatt alle Pläne, begrenzte Zeit. Ab $2.48/mo
Docusaurus

Docusaurus

Docusaurus ist der Dokumentations-Generator von Meta. Er bietet versionierte Dokumentation, Suche, Übersetzungen und ein React-Theme, das Sie Seite für Seite überschreiben können. MIT-Lizenz, über 65.900 GitHub-Sterne.

Auf einen Blick

66k

GitHub-Sterne

1

Seitenaufrufe

Lizenz MIT Version 3.10.2 OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV6,IPV4

Zugriff

  • Docusaurus öffnen: http://<SERVER_IP>

Inhalte bearbeiten und veröffentlichen

1. Fügen Sie Inhaltsdateien hinzu oder bearbeiten Sie sie:

/opt/docusaurus/docs
/opt/docusaurus/blog
/opt/docusaurus/src/pages

2. Aktualisierung /opt/docusaurus/docusaurus.config.js für Website-Einstellungen, Navigation und Theme-Konfiguration.

3. Bauen Sie die Website neu:

cd /opt/docusaurus && npm run build

Nginx liefert die generierten Dateien aus: /opt/docusaurus/build

Nach dem Neubau ist kein Neustart von Nginx nötig.

Wichtige Pfade

  • Projekt: /opt/docusaurus
  • Dokumentation: /opt/docusaurus/docs
  • Blog: /opt/docusaurus/blog
  • Seiten: /opt/docusaurus/src/pages
  • Konfiguration: /opt/docusaurus/docusaurus.config.js
  • Build-Ausgabe: /opt/docusaurus/build
  • Nginx-Konfiguration: /etc/nginx/sites-available/docusaurus.conf

Domain und HTTPS

1. Richten Sie Ihre Domain auf die IP-Adresse des Servers.

2. Bearbeiten Sie die Nginx-Konfiguration und ersetzen Sie server_name _; durch Ihre Domain (z. B. server_name <YOUR_DOMAIN>;):

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

3. Testen Sie die Konfiguration:

nginx -t

4. Installieren Sie Certbot:

apt install -y certbot python3-certbot-nginx

5. Erzeugen Sie ein Let's-Encrypt-Zertifikat:

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

6. Laden Sie Nginx neu:

systemctl reload nginx

7. Aktualisieren Sie die Docusaurus-Website-URL: ersetzen Sie url: 'http://<SERVER_IP>', durch url: 'https://<YOUR_DOMAIN>', in /opt/docusaurus/docusaurus.config.js.

8. Bauen Sie die Website neu:

cd /opt/docusaurus && npm run build

9. Öffnen Sie Ihren Browser und besuchen Sie: https://<YOUR_DOMAIN>

Hinweise

  • Docusaurus erzeugt eine statische Website, eine Datenbank ist nicht erforderlich.
  • Inhaltsänderungen erfordern einen neuen Build, bevor sie öffentlich sichtbar werden.
  • Passen Sie die Docusaurus-Konfiguration und die Projektstruktur nach Ihren Wünschen an.

Mehr zu Entwicklungs-Tools

Verwandte Apps.

Docusaurus jetzt deployen. Ab 2,48 $/Monat.