Creating your site · Docusaurus

Docusaurus a été crée dans l'espoir de rendre plus simple la création de site et de documentation pour votre projet open source.

Après l'installation et la préparation, une grande partie du travail pour créer la base du site pour votre documentation est déjà terminée.

Structure du site

La structure de votre site ressemble à ce qui suit :

root-directory
├── docs
└── website
    ├── blog
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Cela suppose que vous avez supprimé les fichiers d'exemple .md qui ont été installé par le script d'initialisation.

Tous vos fichiers de documentation doivent être placé dans le répertoire docs comme fichier markdown .md. Toutes les publications du blog doivent être à l'intérieur du répertoire blog.

Les fichiers de publications de blog doivent être formatés ainsi YYYY-MM-DD-votre-nom-de-fichier.md

Création d'un site de base

Pour créer un site entièrement fonctionnel, il vous suffit de faire ces quelques étapes :

Ajoutez votre documentation au répertoire /docs sous la forme d'un fichier .md, en vous assurant que vous avez le bon entête dans chaque fichier. Un exemple d'entête serait le suivant, où id est le nom du lien (par exemple, docs/intro.html) et title est le titre de la page Web.
```
---
id: intro
title: Pour commencer
---
Mon nouveau contenu ici..
```
Si vous le souhaitez, ajoutez zéro ou plus de documentations au fichier sidebars.json pour que votre documentation soit rendue dans la barre latérale.

Si vous n'ajoutez pas votre documentation au fichier sidebars.json, les docs seront rendues, mais elles ne pourront être liées qu'à partir d'une autre documentation et visités avec l'URL connue.

Modifiez le fichier website/siteConfig.js pour configurer votre site, en suivant les commentaires inclus dans les docs et le website/siteConfig.js pour vous guider.
Créez n'importe quelle page personnalisée et/ou personnalisez le fichier website/core/Footer.js qui fournit le pied de page de votre site.
Placez les composants, comme les images, dans le dossier website/static/.
Exécutez le site pour voir les résultats de vos modifications.

cd website
yarn run start # our `npm run start`
# Naviguez vers http://localhost:3000

Personnalisation spéciale

Page d'accueil de la documentation

Si vous préférez que votre page d'accueil soit directement dans votre documentation, vous pouvez le faire à travers une redirection.

Supprimez le fichier index.js du répertoire website/pages s'il existe.
Ajoutez une page statique personnalisée index.html dans le répertoire site/static avec le contenu suivant :

<! OCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <meta
      http-equiv="refresh"
      content="0; url=docs/id-of-doc-to-land-on.html"
    />
    <script type="text/javascript">
      window.location.href = 'docs/id-of-doc-to-land-on.html';
    </script>
    <title>Titre de votre site ici</title>
  </head>
  <body>
    Si vous n'êtes pas redirigé automatiquement, suivez ce
    <a href="docs/id-of-doc-to-land-on.html">lien</a>.
  </body>
</html>

Vous obtiendrez l'id du document d'accueil avec les métadonnées .md de cette page de doc.

Blog uniquement

Vous pouvez aussi utiliser Docusaurus pour héberger votre blog uniquement.