Ajouter un 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'en-tête à votre blog dans siteConfig.js
:
headerLinks: [
...
{ blog: true, label: 'Blog' },
...
]
Ajout de messages
To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-my-blog-post-title.md
. La date de publication est extraite du nom du fichier.
For example, at 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...
Options d'en-tête
The only required field is title
; however, we provide options to add author information to your blog post as well along with other options.
auteur
- L'étiquette de texte de l'auteur (byline).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 à l'image de l'auteur. (Note: Si vous utilisez à la foisauthorFBID
etauthorImageURL
,authorFBID
prendra la priorité. N’incluez pasauthorFBID
si vous voulezauthorImageURL
apparaisse.)titre
- Le titre du billet de blog.unlisted
- The post will be accessible by directly visiting the URL but will not show up in the sidebar in the final build; during local development, the post will still be listed. Useful in situations where you want to share a WIP post with others for feedback.
Summary Truncation
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: Truncation Example
---
All this will be part of the blog post summary.
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 par défaut
et tous
. Spécifier une valeur par default
vous permet de changer le titre de la barre latérale par défaut. Spécifier une valeur pour tous
vous permet de changer le titre de la barre latérale lorsque l'option blogSidebarCount
est définie à 'ALL'
.
Exemple :
blogSidebarTitle : { default: 'Recent posts', all: 'All blog posts' },
Flux RSS
Docusaurus fournit un flux RSS simple pour vos articles de blog. Les formats de flux RSS et Atom sont pris en charge. This data is automatically added to your website page's HTML <HEAD>
tag.
A summary of the post's text is provided in the RSS feed up to the <!--truncate-->
. If no <!--truncate-->
tag is found, then all text up to 250 characters is used.
Boutons de réseaux sociaux
Si vous voulez des boutons sociaux Facebook et / ou Twitter au bas de vos billets, définissez les options facebookAppId
et/ou twitter
configuration du site options dans siteConfig.js
.
Advanced Topics
Je veux lancer en mode "Blog Only".
You can run your Docusaurus site without a landing page and instead have your blog load first.
To do this:
- Créer un fichier
index.html
danswebsite/static/
. - Placez le contenu du modèle ci-dessous dans
website/static/index.html
- Personnaliser
<title>
desite/static/index.html
- 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. When the page loads, it will redirect the visitor to/blog
.
You can use this template:
<!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>Title of Your Blog</title>
</head>
<body>
If you are not redirected automatically, follow this
<a href="blog/">link</a>.
</body>
</html>