Installer Docusaurus
Objectif de l’étape : Installer Docusaurus sur votre machine.
- Ouvrez votre terminal.
- Créez un nouveau répertoire pour votre projet :
- Utilisez npx pour créer un nouveau projet Docusaurus :
- Accédez au répertoire de votre site :
Vérification rapide : Vous devriez voir une structure de fichiers similaire à celle-ci :
Erreurs fréquentes : Si vous rencontrez des erreurs lors de l’installation, assurez-vous que Node.js et npm sont correctement installés et à jour.
Configurer le site
Objectif de l’étape : Configurer les paramètres de base de votre site.
- Ouvrez le fichier `docusaurus.config.js` dans votre éditeur de texte préféré.
- Modifiez les paramètres de base tels que `title`, `tagline`, `url`, et `baseUrl`.
Vérification rapide : Enregistrez le fichier et vérifiez qu’il n’y a pas d’erreurs de syntaxe.
Erreurs fréquentes : Assurez-vous que les URLs sont correctement formatées et que les guillemets sont bien fermés.
Ajouter des pages de documentation
Objectif de l’étape : Ajouter des pages de documentation à votre site.
- Naviguez vers le répertoire `docs`.
- Créez un nouveau fichier Markdown pour chaque page de documentation. Par exemple, créez un fichier nommé `introduction.md`.
- Ajoutez le chemin de votre nouvelle page dans le fichier `sidebars.js`.
Vérification rapide : Lancez le serveur de développement pour vérifier que votre nouvelle page est accessible :
Ouvrez votre navigateur et allez à `http://localhost:3000/docs/introduction`.
Erreurs fréquentes : Assurez-vous que les chemins dans `sidebars.js` correspondent exactement aux noms des fichiers Markdown.
Ajouter un blog
Objectif de l’étape : Ajouter une section de blog à votre site.
- Naviguez vers le répertoire `blog`.
- Créez un nouveau fichier Markdown pour chaque article de blog. Par exemple, créez un fichier nommé `2023-01-01-premier-article.md`.
Vérification rapide : Lancez le serveur de développement et allez à `http://localhost:3000/blog/2023-01-01-premier-article`.
Erreurs fréquentes : Assurez-vous que la date dans le fichier Markdown est au format `YYYY-MM-DD`.
Personnaliser le thème
Objectif de l’étape : Personnaliser l’apparence de votre site.
- Ouvrez le fichier `docusaurus.config.js`.
- Modifiez les paramètres de thème sous la section `themeConfig`.
Vérification rapide : Lancez le serveur de développement et vérifiez que les modifications apparaissent correctement.
Erreurs fréquentes : Assurez-vous que les chemins des images et des liens sont corrects.
Déployer le site
Objectif de l’étape : Déployer votre site sur GitHub Pages.
- Assurez-vous que votre projet est sous contrôle de version avec Git.
- Ajoutez un fichier `deploy.sh` à la racine de votre projet avec le contenu suivant :
bash #!/bin/bash
Conclusion
Pour toute question ou assistance, n’hésitez pas à nous contacter au 09 77 29 09 69. Notre équipe d’experts est là pour vous accompagner dans vos projets.
Commentaires (2)
Merci pour ce guide détaillé ! J’ai réussi à installer Docusaurus sans problème grâce à vos instructions.
Merci pour ce guide détaillé ! J’ai pu installer Docusaurus sans problème grâce à vos instructions claires.