Préparation du site · Docusaurus

Après l'installation de Docusaurus, vous avez maintenant un squelette de travail pour votre site web spécifique. La section suivante présente le reste de la structure de Docusaurus afin que vous puissiez préparer votre site.

Structure de fichiers

Comme indiqué après l'installation de Docusaurus, le script d'initialisation a crée une structure de dossier similaire à:

root-directory
├── .gitignore
├── docs
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog
    │   ├── 2016-03-11-blog-post.md
    │   ├── 2017-04-10-blog-post-two.md
    │   ├── 2017-09-25-testing-rss.md
    │   ├── 2017-09-26-adding-rss.md
    │   └── 2017-10-24-new-version-1.0.0.md
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Description des dossiers

Fichiers source de la documentation : Le répertoire docs contient les fichiers d'exemple de la documentation écrite en Markdown.
Blog: Le répertoire website/blog contient les exemples de publication du blog écrits en markdown.
Pages: Le répertoire website/pages contient les exemples des pages de premier niveau pour le site.
Fichiers statiques et images: Le répertoire website/static contient les composants statiques utilisé par le site web d'exemple.

Fichiers clé

Pied de page: Le fichier website/core/Footer.js est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.
Fichier de configuration: Le fichier website/siteConfig.js est le principal fichier de configuration utilisé par Docusaurus.
Barre latérale: Le fichier sidebars.json contient la structure et l'ordre des fichiers de la documentation.
.gitignore: Le fichier .gitignore liste les fichiers ignorés nécessaires pour le site généré afin qu'ils ne soient pas ajoutés au repo git.

Informations de préparation

Vous devez garder les fichiers website/siteConfig.js et website/core/Footer.js, mais vous pouvez les éditer comme vous le souhaitez. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. Au minimum, vous devriez avoir un fichier en/index.js ou en/index.html à l'intérieur du website/pages et une image à utiliser comme icône de votre entête à l'intérieur de website/static.

Si votre répertoire n'a pas encore de .gitignore, nous le générons avec la liste des fichiers ignorés nécessaires. En règle générale, vous devriez ignorer tous les node_modules, les fichiers de construction, les fichiers système (.DS_Store), les logs, etc. Ici une liste plus complète de ce qui est normalement ignoré pour les projets Node.js.