Aller au contenu principal
50 % de réduction toutes les offres, durée limitée. À partir de $2.48/mo
Docusaurus

Docusaurus

Docusaurus est le générateur de sites de documentation de Meta. Il apporte la gestion des versions, la recherche, les traductions et un thème React que vous pouvez surcharger page par page. Sous licence MIT, avec plus de 65 900 étoiles GitHub.

En un coup d'œil

66k

Étoiles GitHub

1

Vues de page

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

Accès

  • Ouvrez Docusaurus : http://<SERVER_IP>

Modifier et publier du contenu

1. Ajoutez ou modifiez des fichiers de contenu :

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

2. Mettez à jour /opt/docusaurus/docusaurus.config.js pour les paramètres du site, la navigation et la configuration du thème.

3. Reconstruisez le site :

cd /opt/docusaurus && npm run build

Nginx sert les fichiers générés depuis : /opt/docusaurus/build

Aucun redémarrage de Nginx n'est nécessaire après une reconstruction.

Chemins importants

  • Projet : /opt/docusaurus
  • Documentation : /opt/docusaurus/docs
  • Blog : /opt/docusaurus/blog
  • Pages : /opt/docusaurus/src/pages
  • Configuration : /opt/docusaurus/docusaurus.config.js
  • Sortie de build : /opt/docusaurus/build
  • Configuration Nginx : /etc/nginx/sites-available/docusaurus.conf

Domaine et HTTPS

1. Faites pointer votre domaine vers l'adresse IP du serveur.

2. Modifiez la configuration Nginx et remplacez server_name _; par votre domaine (par exemple, server_name <YOUR_DOMAIN>;):

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

3. Testez la configuration :

nginx -t

4. Installez Certbot :

apt install -y certbot python3-certbot-nginx

5. Générez un certificat Let's Encrypt :

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

6. Rechargez Nginx :

systemctl reload nginx

7. Mettez à jour l'URL du site Docusaurus : remplacez url: 'http://<SERVER_IP>', par url: 'https://<YOUR_DOMAIN>', in /opt/docusaurus/docusaurus.config.js.

8. Reconstruisez le site :

cd /opt/docusaurus && npm run build

9. Ouvrez votre navigateur et allez sur : https://<YOUR_DOMAIN>

Remarques

  • Docusaurus génère un site statique : aucune base de données n'est requise.
  • Les modifications de contenu nécessitent une nouvelle build avant d'être visibles publiquement.
  • Modifiez la configuration de Docusaurus et la structure du projet selon vos préférences.

Plus dans Outils de développement

Apps connexes.

Déployer Docusaurus maintenant. À partir de 2,48 $/mois.