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 vos projets open source.

Après l'installation et la preparation, 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 sous la forme de fichier markdown .md. Tout les publications du blog doivent être à l'intérieur du répertoire blog.

Les fichiers de publications de blog doivent être formatés comme 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 :

Ajouter votre documentation au répertoire /docs sous la forme d'une fichier .md, en vous assurant que vous avez le bon en-tête dans chaque fichier. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
```
---
id: intro
title: Getting Started
---

My new content here..
```
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.

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
Place les composants, comme les images, dans le dossier website/static/.
Run the site to see the results of your changes.

cd website
yarn run start # or `npm run start`
# Navigate to 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.

Remove the index.js file from the website/pages directory, if it exists.
Ajouter une page statique personnalisée index.html dans le répertoire site/static avec le contenu suivant :

<!DOCTYPE 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>Your Site Title Here</title>
  </head>
  <body>
    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
  </body>
</html>

You will get the id of the document to land on the .md metadata of that doc page.

Blog uniquement

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