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

Docusaurus

Docusaurus is de documentatiegenerator van Meta. U krijgt geversioneerde documentatie, zoeken, vertalingen en een React-thema dat u per pagina kunt overschrijven. MIT-licentie met meer dan 65.900 GitHub-sterren.

In een oogopslag

66k

GitHub-sterren

1

Paginaweergaven

Licentie MIT Versie 3.10.2 OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV6,IPV4

Toegang

  • Open Docusaurus: http://<SERVER_IP>

Inhoud bewerken en publiceren

1. Voeg inhoudsbestanden toe of bewerk ze:

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

2. Update /opt/docusaurus/docusaurus.config.js voor site-instellingen, navigatie en themaconfiguratie.

3. Bouw de site opnieuw:

cd /opt/docusaurus && npm run build

Nginx levert de gegenereerde bestanden uit: /opt/docusaurus/build

Na het opnieuw bouwen hoeft Nginx niet te worden herstart.

Belangrijke paden

  • Project: /opt/docusaurus
  • Documentatie: /opt/docusaurus/docs
  • Blog: /opt/docusaurus/blog
  • Pagina's: /opt/docusaurus/src/pages
  • Configuratie: /opt/docusaurus/docusaurus.config.js
  • Build-uitvoer: /opt/docusaurus/build
  • Nginx-configuratie: /etc/nginx/sites-available/docusaurus.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/docusaurus.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 Docusaurus-site-URL bij: vervang url: 'http://<SERVER_IP>', door url: 'https://<YOUR_DOMAIN>', in /opt/docusaurus/docusaurus.config.js.

8. Bouw de site opnieuw:

cd /opt/docusaurus && npm run build

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

Opmerkingen

  • Docusaurus genereert een statische site: er is geen database nodig.
  • Inhoudswijzigingen vereisen een nieuwe build voordat ze publiek zichtbaar zijn.
  • Pas de Docusaurus-configuratie en de projectstructuur aan naar uw voorkeuren.

Meer in Development-tools

Gerelateerde apps.

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