next

Translate

Adding a Blog

Configuration initiale

Pour configurer votre site de blogs, commencez par créer un répertoire blog dans votre répertoire website.

Ensuite, ajoutez un lien d'entête à votre blog dans siteConfig.js :

headerLinks: [
    ...
    { blog: true, label: 'Blog' },
    ...
]

Ajout d'articles

Pour publier dans le blog, créez un fichier dans le dossier du blog avec un nom au format AAAA-MM-JJ-Mon-Blog-Billet-Titre.md. La date de publication est extraite du nom du fichier.

Par exemple, dans website/blog/2017-12-14-Introducing-docusaurus.md:

---
title: Introducing Docusaurus
author: Joel Marcey
authorURL: http://twitter.com/JoelMarcey
authorFBID: 611217057
authorTwitter: JoelMarcey
---
Lorem Ipsum...

Adding slug will override the url of the blog post.

Par exemple :

---
slug: introducing-docusaurus
title: Introducing Docusaurus
author: Joel Marcey
authorURL: http://twitter.com/JoelMarcey
authorFBID: 611217057
authorTwitter: JoelMarcey
---
Lorem Ipsum...

Will be available at https://website/blog/introducing-docusaurus

Options d'entête

Le seul champ requis est title, cependant, nous fournissons des options pour ajouter des informations sur l'auteur à votre blog ainsi que d'autres options.

  • author - L'étiquette du texte de l'auteur par ligne.
  • authorURL - L'URL associée à l'auteur. Ceci pourrait être un compte Twitter, GitHub, Facebook, etc.
  • authorFBID - L'ID de profil Facebook qui est utilisé pour récupérer l'image de profil.
  • authorImageURL - L'URL vers l'image de l'auteur. (Remarque : Si vous utilisez à la fois authorFBID et authorImageURL, authorFBID prendra la priorité. N’incluez pas authorFBID si vous voulez que authorImageURL apparaisse.)
  • title - Le titre de l'article du blog.
  • slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
  • unlisted - L'article sera accessible en visitant directement l'URL mais ne s'affichera pas dans la barre latérale de la version finale; pendant le développement local, l'article sera toujours listé. Utile dans les situations où vous voulez partager un article en cours de construction avec d'autres personnes pour les commentaires.
  • draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.

Résumé de l'article

Utilisez le marqueur <!--truncate--> dans votre message de blog pour représenter ce qui sera affiché comme résumé lors de l'affichage de tous les articles de blog publiés. Tout ce qui précède <!--truncate--> fera partie du résumé. Par exemple :

---
title: Exemple de résumé
---
Tout ceci fera partie du résumé du blog post.

Même cela.

<!--truncate-->

Mais ce qui est ici ne le sera pas.

Comme ici.

Ou là.

Changer le nombre de messages du blog sur la barre latérale

Par défaut, 5 messages récents sont affichés sur la barre latérale.

Vous pouvez configurer un nombre spécifique de messages de blog à afficher en ajoutant un paramètre blogSidebarCount à votre siteConfig.js.

Les options disponibles sont un entier représentant le nombre de messages à afficher ou une chaîne avec la valeur 'ALL'.

Exemple :

blogSidebarCount: 'ALL',

Changer le titre de la barre latérale

Vous pouvez configurer un titre de barre latérale spécifique en ajoutant un paramètre blogSidebarTitle à votre siteConfig.js.

L'option est un objet qui peut avoir les clés default et all. Spécifier une valeur pour default vous permet de changer le titre par défaut de la barre latérale. Spécifier une valeur pour all vous permet de changer le titre de la barre latérale lorsque l'option blogSidebarCount est définie à 'ALL'.

Exemple :

blogSidebarTitle : { default: 'Articles récents', all: 'Tous les articles du blog' },

Flux RSS

Docusaurus fournit un flux RSS pour vos articles de blog. Les formats de flux RSS et Atom sont pris en charge. Ces données sont automatiquement ajoutées sur le tag HTML <HEAD> de votre page web.

Un résumé du texte du message est fourni dans le flux RSS depuis <!--truncate-->. If no <!--truncate--> tag is found, then all text up to 250 characters are used.

Boutons de réseaux sociaux

Si vous voulez des boutons sociaux Facebook et/ou Twitter au bas de vos articles de blog, définissez les options facebookAppId et/ou twitter de la configuration du site dans siteConfig.js.

Sujets avancés

Je veux exécuter en mode "Blog uniquement".

Vous pouvez exécuter votre site Docusaurus sans page d'accueil et avoir en premier votre blog.

Pour faire cela :

  1. Créer un fichier index.html dans website/static/.
  2. Placez le contenu du modèle ci-dessous dans website/static/index.html
  3. Personnaliser <title> de site/static/index.html
  4. Supprimer la page d'accueil dynamique website/pages/fr/index.js

Maintenant, lorsque Docusaurus génère ou construit votre site, il copiera le fichier de static/index.html et le placera dans le répertoire principal du site. Le fichier statique est utilisé lorsqu'un visiteur arrive sur votre page. Lorsque la page charge, elle redirigera le visiteur vers /blog.

Vous pouvez utiliser ce modèle :

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="refresh" content="0; url=blog/" />
    <script type="text/javascript">
      window.location.href = 'blog/';
    </script>
    <title>Titre de botre blog</title>
  </head>
  <body>
    Si vous n'êtes pas redirigé automatiquement, suivez ce
    <a href="blog/">lien</a>.
  </body>
</html>
← DockerCustom Pages →