Aller au contenu principal
Version : 3.4.0

📦 plugin-content-blog

Fournit la fonctionnalité Blog et c'est le plugin par défaut du blog de Docusaurus.

certaines fonctionnalités uniquement en production

La fonctionnalité flux fonctionne en extrayant la sortie de compilation, et n'est active qu'en production.

Installation​

npm install --save @docusaurus/plugin-content-blog
astuce

Si vous utilisez le preset @docusaurus/preset-classic, vous n'avez pas besoin d'installer ce plugin en tant que dépendance.

Vous pouvez configurer ce plugin via les options du preset.

Configuration​

Champs acceptés :

NomTypePar défautDescription
pathstring'blog'Chemin vers le répertoire de contenu du blog sur le système de fichiers, relatif au répertoire du site.
editUrlstring | EditUrlFnundefinedURL de base pour modifier votre site. L'URL finale est calculée par editUrl + relativePostPath. L'utilisation d'une fonction permet un contrôle plus nuancé pour chaque fichier. Omettre cette variable désactivera entièrement les liens de modification.
editLocalizedFilesbooleanfalseL'URL de modification ciblera le fichier localisé, au lieu du fichier original non localisé. Ignoré lorsque editUrl est une fonction.
blogTitlestring'Blog'Titre de la page du blog pour un meilleur référencement.
blogDescriptionstring'Blog'Description de la page du blog pour un meilleur référencement.
blogSidebarCountnumber | 'ALL'5Nombre d'articles du blog à afficher dans la barre latérale du blog. 'ALL' pour montrer tous les articles du blog; 0 pour désactiver.
blogSidebarTitlestring'Recent posts'Titre de la barre latérale du blog.
routeBasePathstring'blog'Route URL pour la section blog de votre site. NE PAS inclure un slash de fin. Utilisez / pour mettre le blog à la racine du chemin.
tagsBasePathstring'tags'Route URL pour la section des tags de votre blog. Sera ajouté à routeBasePath.
pageBasePathstring'page'Route URL pour la section des pages de votre blog. Sera ajouté à routeBasePath.
archiveBasePathstring | null'archive'Route d'URL pour la section archive de votre blog. Sera ajouté à routeBasePath. NE PAS inclure un slash de fin. Utilisez null pour désactiver la génération d'archives.
includestring[]['**/*.{md,mdx}']Tableau de patterns de glob correspondant aux fichiers Markdown à construire, relatif au chemin de contenu.
excludestring[]Voir l'exemple de configurationTableau de patterns de glob correspondant aux fichiers Markdown à exclure. Sert d'affinement basé sur l'option include.
postsPerPagenumber | 'ALL'10Nombre d'articles à afficher par page dans la liste. Utilisez 'ALL' pour afficher tous les articles sur une page de liste.
blogListComponentstring'@theme/BlogListPage'Composant racine de la page de liste du blog.
blogPostComponentstring'@theme/BlogPostPage'Composant racine de chaque page d'article du blog.
blogTagsListComponentstring'@theme/BlogTagsListPage'Composant racine de la page de la liste des tags.
blogTagsPostsComponentstring'@theme/BlogTagsPostsPage'Composant racine de la page « articles contenant le tag ».
blogArchiveComponentstring'@theme/BlogArchivePage'Composant racine de la page d'archive du blog.
remarkPluginsany[][]Plugins Remark passés à MDX.
rehypePluginsany[][]Plugins Rehype passés à MDX.
beforeDefaultRemarkPluginsany[][]Les plugins Remark personnalisés sont transmis à MDX avant les plugins Remark par défaut de Docusaurus.
beforeDefaultRehypePluginsany[][]Les plugins Rehype personnalisés sont transmis à MDX avant les plugins Rehype par défaut de Docusaurus.
truncateMarkerRegExp/<!--\s*truncate\s*-->/\{\/\*\s*truncate\s*\*\/\}/
showReadingTimebooleantrueAffiche le temps de lecture estimé pour l'article du blog.
readingTimeReadingTimeFnLe temps de lecture par défautUn callback pour personnaliser le nombre du temps de lecture affiché.
authorsMapPathstring'authors.yml'Chemin vers le fichier map des auteurs, relatif au répertoire de contenu du blog.
feedOptionsVoir ci-dessous{type: ['rss', 'atom']}Flux du blog.
feedOptions.typeFeedType | FeedType[] | 'all' | nullObligatoireType de flux à générer. Utilisez null pour désactiver la génération.
feedOptions.createFeedItemsCreateFeedItemsFn | undefinedundefinedUne fonction optionnelle qui peut être utilisée pour transformer et / ou filtrer les éléments du flux.
feedOptions.limitnumber | null | false20Limite le flux au nombre spécifié d'articles, false ou null pour avoir toutes les entrées. Par défaut, 20.
feedOptions.titlestringsiteConfig.titleTitre du flux.
feedOptions.descriptionstring`${siteConfig.title} Blog`Description du flux.
feedOptions.copyrightstringundefinedMessage de copyright.
feedOptions.languagestring (Voir documentation pour les valeurs possibles)undefinedMétadonnées de langue du flux.
sortPosts'descending' | 'ascending' 'descending'Détermine l'orientation du tri des articles du blog.
processBlogPostsProcessBlogPostsFnundefinedUne fonction facultative qui peut être utilisée pour transformer les articles de blog (filtre, modification, suppression, etc...).
showLastUpdateAuthorbooleanfalseAffichage ou non de l'auteur de la dernière mise à jour de l'article du blog.
showLastUpdateTimebooleanfalseAffichage ou non de la dernière date de mise à jour de l'article du blog. Cela nécessite l'accès à l'historique git pendant la construction, et ne fonctionnera donc pas correctement avec des clones superficiels (un défaut courant pour les systèmes de CI). With GitHub actions/checkout, usefetch-depth: 0.
tagsstring | false | null | undefinedtags.ymlPath to the YAML tags file listing pre-defined tags. Relative to the blog content directory.
onInlineTags'ignore' | 'log' | 'warn' | 'throw'warnThe plugin behavior when blog posts contain inline tags (not appearing in the list of pre-defined tags, usually tags.yml).

Types​

EditUrlFn​

type EditUrlFunction = (params: {
blogDirPath: string;
blogPath: string;
permalink: string;
locale: string;
}) => string | undefined;

ReadingTimeFn​

type ReadingTimeOptions = {
wordsPerMinute: number;
wordBound: (char: string) => boolean;
};

type ReadingTimeCalculator = (params: {
content: string;
frontMatter?: BlogPostFrontMatter & Record<string, unknown>;
options?: ReadingTimeOptions;
}) => number;

type ReadingTimeFn = (params: {
content: string;
frontMatter: BlogPostFrontMatter & Record<string, unknown>;
defaultReadingTime: ReadingTimeCalculator;
}) => number | undefined;

FeedType​

type FeedType = 'rss' | 'atom' | 'json';

CreateFeedItemsFn​

type CreateFeedItemsFn = (params: {
blogPosts: BlogPost[];
siteConfig: DocusaurusConfig;
outDir: string;
defaultCreateFeedItemsFn: CreateFeedItemsFn;
}) => Promise<BlogFeedItem[]>;

ProcessBlogPostsFn​

type ProcessBlogPostsFn = (params: {
blogPosts: BlogPost[];
}) => Promise<void | BlogPost[]>;

Exemple de configuration​

Vous pouvez configurer ce plugin via les options du preset ou du plugin.

astuce

La plupart des utilisateurs de Docusaurus configurent ce plugin via les options du preset.

Si vous utilisez un preset, configurez ce plugin via le options du preset :

docusaurus.config.js
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
blog: {
path: 'blog',
// Cas d'utilisation simple : chaîne editUrl
// editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/',
// Cas d'utilisation avancé : fonction editUrl
editUrl: ({locale, blogDirPath, blogPath, permalink}) =>
`https://github.com/facebook/docusaurus/edit/main/website/${blogDirPath}/${blogPath}`,
editLocalizedFiles: false,
blogTitle: 'Blog title',
blogDescription: 'Blog',
blogSidebarCount: 5,
blogSidebarTitle: 'Tous nos articles',
routeBasePath: 'blog',
include: ['**/*.{md,mdx}'],
exclude: [
'**/_*.{js,jsx,ts,tsx,md,mdx}',
'**/_*/**',
'**/*.test.{js,jsx,ts,tsx}',
'**/__tests__/**',
],
postsPerPage: 10,
blogListComponent: '@theme/BlogListPage',
blogPostComponent: '@theme/BlogPostPage',
blogTagsListComponent: '@theme/BlogTagsListPage',
blogTagsPostsComponent: '@theme/BlogTagsPostsPage',
remarkPlugins: [require('./my-remark-plugin')],
rehypePlugins: [],
beforeDefaultRemarkPlugins: [],
beforeDefaultRehypePlugins: [],
truncateMarker: /<!--\s*(truncate)\s*-->/,
showReadingTime: true,
feedOptions: {
type: '',
title: '',
description: '',
copyright: '',
language: undefined,
createFeedItems: async (params) => {
const {blogPosts, defaultCreateFeedItems, ...rest} = params;
return defaultCreateFeedItems({
// ne conserve que les 10 articles du blog les plus récents dans le fil d'actualité
blogPosts: blogPosts.filter((item, index) => index < 10),
...rest,
});
},
},
},
},
],
],
};

Front matter du Markdown​

Les documents Markdown peuvent utiliser les champs de métadonnées Markdown du front matter suivants, entourés d'une ligne --- de part et d'autre.

Champs acceptés :

NomTypePar défautDescription
authorsAuthorsundefinedListe des auteurs de l'article du blog (ou auteur unique). Lisez le guide authors pour plus d'explications. Préférez authors aux champs frontMatter author_*, même pour les articles du blog avec un seul auteur.
authorstringundefined⚠️ Préférez l'utilisation de authors. Le nom de l'auteur de l'article du blog.
author_urlstringundefined⚠️ Préférez l'utilisation de authors. L'URL à laquelle le nom de l'auteur sera lié. Il peut s'agir de l'URL d'un profil GitHub, Twitter, Facebook, etc.
author_image_urlstringundefined⚠️ Préférez l'utilisation de authors. L'URL de l'image miniature de l'auteur.
author_titlestringundefined⚠️ Préférez l'utilisation de authors. Une description de l'auteur.
titlestringTitre du MarkdownLe titre de l'article du blog.
datestringNom du fichier ou heure de création du fichierLa date de création de l'article du blog. Si non spécifié, ceci peut être extrait du nom du fichier ou du dossier, par exemple 2021-04-15-blog-post.mdx, 2021-04-15-blog-post/index.mdx, 2021/04/15/blog-post.mdx. Sinon, c'est l'heure de création du fichier Markdown.
tagsTag[]undefinedUne liste de chaînes ou d'objets de deux champs de chaîne label et permalink pour taguer vos articles. Strings can be a reference to keys of a tags file (usually tags.yml)
draftbooleanfalseLes brouillons d'articles du blog seront disponibles uniquement lors du développement.
unlistedbooleanfalseLes articles de blog non listés seront disponibles à la fois en développement et en production. Ils seront « cachés » en production, non indexés, exclus des sitemaps, et ne peuvent être consultés que par les utilisateurs ayant un lien direct.
hide_table_of_contentsbooleanfalseS'il faut cacher la table des matières à droite.
toc_min_heading_levelnumber2Le niveau de titre minimum affiché dans la table des matières. Doit être compris entre 2 et 6 et inférieur ou égal à la valeur maximale.
toc_max_heading_levelnumber3Le niveau de titre maximum affiché dans la table des matières. Doit être compris entre 2 et 6.
keywordsstring[]undefinedMéta-tag de mots-clés, qui deviendront les <meta name="keywords" content="keyword1,keyword2,..."/> dans <head>, utilisés par les moteurs de recherche.
descriptionstringLa première ligne du contenu MarkdownLa description de votre document qui deviendra <meta name="description" content="..."/> et <meta property="og:description" content="..."/> dans <head>, utilisés par les moteurs de recherche.
imagestringundefinedCover or thumbnail image that will be used as the <meta property="og:image" content="..."/> in the <head>, enhancing link previews on social media and messaging platforms.
slugstringChemin du fichierPermet de personnaliser l'URL de l'article du blog (/<routeBasePath>/<slug>). Prise en charge de multiples formats : slug: my-blog-post, slug: /my/path/to/blog/post, slug: /.
last_updateFrontMatterLastUpdateundefinedPermet de remplacer l'auteur et/ou la date de la dernière mise à jour. La date peut être n'importe quelle chaîne de date interprétable.
type FrontMatterLastUpdate = {date?: string; author?: string};

type Tag = string | {label: string; permalink: string};

// Une clé d'auteur fait référence à un auteur du fichier authors.yml du plugin global
type AuthorKey = string;

type Author = {
key?: AuthorKey;
name: string;
title?: string;
url?: string;
image_url?: string;
};

// Le champ authors du frontMatter permet plusieurs formes possibles
type Authors = AuthorKey | Author | (AuthorKey | Author)[];

Exemple :

---
title: Welcome Docusaurus
authors:
- slorber
- yangshun
- name: Joel Marcey
title: Co-creator of Docusaurus 1
url: https://github.com/JoelMarcey
image_url: https://github.com/JoelMarcey.png
tags: [docusaurus]
description: This is my first post on Docusaurus.
image: https://i.imgur.com/mErPwqL.png
hide_table_of_contents: false
---

A Markdown blog post

Tags File​

Use the tags plugin option to configure the path of a YAML tags file.

By convention, the plugin will look for a tags.yml file at the root of your content folder(s).

This file can contain a list of predefined tags. You can reference these tags by their keys in Markdown files thanks to the tags front matter.

Keeping tags consistent

Using a tags file, you can ensure that your tags usage is consistent across your plugin content set. Use the onInlineTags: 'throw' plugin option to enforce this consistency and prevent usage of inline tags declared on the fly.

Types​

The YAML content of the provided tags file should respect the following shape:

type Tag = {
label?: string; // Tag display label
permalink?: string; // Tag URL pathname segment
description?: string; // Tag description displayed in the tag page
};

type TagsFileInput = Record<string, Partial<Tag> | null>;

Example​

tags.yml
releases:
label: 'Product releases'
permalink: '/product-releases'
description: 'Content related to product releases.'

# A partial tag definition is also valid
announcements:
label: 'Announcements'

# An empty tag definition is also valid
# Other attributes will be inferred from the key
emptyTag:
content.md
---
tags: [releases, announcements, emptyTag]
---

# Title

Content

i18n​

Lisez d'abord l'introduction i18n .

Emplacement des fichiers de traduction​

  • Chemin de base : website/i18n/[locale]/docusaurus-plugin-content-blog
  • Chemin d'accès multi-instance : website/i18n/[locale]/docusaurus-plugin-content-blog-[pluginId]
  • Fichiers JSON : extrait avec docusaurus write-translations
  • Fichiers Markdown : website/i18n/[locale]/docusaurus-plugin-content-blog

Exemple de structure du système de fichiers​

website/i18n/[locale]/docusaurus-plugin-content-blog
│
│ # traductions pour website/blog
├── authors.yml
├── first-blog-post.md
├── second-blog-post.md
│
│ # traductions pour les options du plugin qui seront rendues
└── options.json