Aller au contenu principal
Version: 2.0.0-beta.5 🚧

📦 plugin-content-blog

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

Installation#

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

Si vous avez installé @docusaurus/preset-classic, vous n'avez pas besoin de l'installer en tant que dépendance. Vous pouvez également le configurer via les options du preset classic au lieu de le faire comme ci-dessous.

Configuration#

docusaurus.config.js
module.exports = {  plugins: [    [      '@docusaurus/plugin-content-blog',      {        /**         * Chemin vers les données sur le système de fichiers par rapport au répertoire du site.         */        path: 'blog',        /**         * Url de base pour éditer votre site.         * Docusaurus calculera le editUrl final avec "editUrl + relativeDocPath".         */        editUrl: 'https://github.com/facebook/docusaurus/edit/master/website/',        /**         * Pour les cas particuliers, calculez vous-même l'url d'édition pour chaque fichier Markdown.         */        editUrl: ({locale, blogDirPath, blogPath, permalink}) => {          return `https://github.com/facebook/docusaurus/edit/master/website/${blogDirPath}/${blogPath}`;        },        /**         * Utile si vous committez des fichiers localisés à git.         * Lorsque les fichiers Markdown sont localisés, l'Url d'édition ciblera le fichier localisé,         * au lieu du fichier original non localisé.         * Remarque : cette option est ignorée lorsque editUrl est une fonction         */        editLocalizedFiles: false,        /**         * Titre de la page du blog pour un meilleur référencement         */        blogTitle: 'Titre du blog',        /**         * Meta description de la page du blog pour un meilleur référencement         */        blogDescription: 'Blog',        /**         * Nombre d'articles à visualiser dans la barre latérale du blog         * 'ALL' pour afficher tous les articles du blog         * 0 pour le désactiver         */        blogSidebarCount: 5,        /**         * Titre de la barre latérale du blog         */        blogSidebarTitle: 'Tous nos articles',        /**         * route URL pour la section blog de votre site.         * * * NE PAS inclure de slash.         */        routeBasePath: 'blog',        include: ['*.md', '*.mdx'],        /**         * Aucune route ne sera créée pour les fichiers correspondants         */        exclude: [          '**/_*.{js,jsx,ts,tsx,md,mdx}',          '**/_*/**',          '**/*.test.{js,jsx,ts,tsx}',          '**/__tests__/**',        ],        postsPerPage: 10,        /**         * Composants du thème utilisés par les pages du blog.         */        blogListComponent: '@theme/BlogListPage',        blogPostComponent: '@theme/BlogPostPage',        blogTagsListComponent: '@theme/BlogTagsListPage',        blogTagsPostsComponent: '@theme/BlogTagsPostsPage',        /**         * Les plugins Remark et Rehype passés à MDX.         */        remarkPlugins: [          /* require('remark-math') */        ],        rehypePlugins: [],        /**         * Les plugins Remark et Rehype personnalisés sont passés à MDX avant         * les plugins Docusaurus Remark et Rehype par défaut.         */        beforeDefaultRemarkPlugins: [],        beforeDefaultRehypePlugins: [],        /**         * Truncate marker, peut être une regex ou une chaîne.         */        truncateMarker: /<!--\s*(truncate)\s*-->/,        /**         * Affiche le temps de lecture estimé pour l'article du blog.         */        showReadingTime: true,        /**         * Flux du blog.         * Si feedOptions est undefined, aucun flux rss ne sera généré.         */        feedOptions: {          type: '', // requis. 'rss' | 'feed' | 'all'          title: '', // par défaut à siteConfig.title          description: '', // par défaut à  `${siteConfig.title} Blog`          copyright: '',          language: undefined, // valeurs possibles : http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes        },      },    ],  ],};

i18n#

Lisez l’introduction i18n en premier.

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: N/A
  • 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├── first-blog-post.md└── second-blog-post.md