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

Docusaurus

Docusaurus je generátor dokumentačních webů od Meta. Nabízí verzovanou dokumentaci, vyhledávání, překlady a React téma, které můžete přepsat stránku po stránce. Licence MIT a více než 65 900 hvězd na GitHubu.

Na první pohled

66k

Hvězdičky na GitHubu

1

Zobrazení stránky

Licence MIT Verze 3.10.2 OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV6,IPV4

Přístup

  • Otevřete Docusaurus: http://<SERVER_IP>

Úprava a publikování obsahu

1. Přidejte nebo upravte soubory s obsahem:

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

2. Aktualizace /opt/docusaurus/docusaurus.config.js pro nastavení webu, navigaci a konfiguraci tématu.

3. Znovu sestavte web:

cd /opt/docusaurus && npm run build

Nginx servíruje vygenerované soubory z: /opt/docusaurus/build

Po znovusestavení není nutné restartovat Nginx.

Důležité cesty

  • Projekt: /opt/docusaurus
  • Dokumentace: /opt/docusaurus/docs
  • Blog: /opt/docusaurus/blog
  • Stránky: /opt/docusaurus/src/pages
  • Konfigurace: /opt/docusaurus/docusaurus.config.js
  • Výstup buildu: /opt/docusaurus/build
  • Konfigurace Nginx: /etc/nginx/sites-available/docusaurus.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/docusaurus.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 Docusaurus: nahraďte url: 'http://<SERVER_IP>', za url: 'https://<YOUR_DOMAIN>', in /opt/docusaurus/docusaurus.config.js.

8. Znovu sestavte web:

cd /opt/docusaurus && npm run build

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

Poznámky

  • Docusaurus generuje statický web, databáze není potřeba.
  • Změny obsahu vyžadují nový build, než se zveřejní.
  • Upravte konfiguraci Docusaurus a strukturu projektu podle svých preferencí.

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

Související aplikace.

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