📦 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
- Yarn
- pnpm
- Bun
npm install --save @docusaurus/plugin-content-blog
yarn add @docusaurus/plugin-content-blog
pnpm add @docusaurus/plugin-content-blog
bun add @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 :
| Nom | Type | Par défaut | Description |
|---|---|---|---|
path | string | 'blog' | Chemin vers le répertoire de contenu du blog sur le système de fichiers, relatif au répertoire du site. |
editUrl | string | EditUrlFn | undefined | URL 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. |
editLocalizedFiles | boolean | false | L'URL de modification ciblera le fichier localisé, au lieu du fichier original non localisé. Ignoré lorsque editUrl est une fonction. |
blogTitle | string | 'Blog' | Titre de la page du blog pour un meilleur référencement. |
blogDescription | string | 'Blog' | Description de la page du blog pour un meilleur référencement. |
blogSidebarCount | number | 'ALL' | 5 | Nombre d'articles du blog à afficher dans la barre latérale du blog. 'ALL' pour montrer tous les articles du blog; 0 pour désactiver. |
blogSidebarTitle | string | 'Recent posts' | Titre de la barre latérale du blog. |
routeBasePath | string | '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. |
tagsBasePath | string | 'tags' | Route URL pour la section des tags de votre blog. Sera ajouté à routeBasePath. |
pageBasePath | string | 'page' | Route URL pour la section des pages de votre blog. Sera ajouté à routeBasePath. |
archiveBasePath | string | 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. |
authorsBasePath | string | 'authors' | URL route for the authors pages of your blog. Will be appended to path. |
include | string[] | ['**/*.{md,mdx}'] | Tableau de patterns de glob correspondant aux fichiers Markdown à construire, relatif au chemin de contenu. |
exclude | string[] | Voir l'exemple de configuration | Tableau de patterns de glob correspondant aux fichiers Markdown à exclure. Sert d'affinement basé sur l'option include. |
postsPerPage | number | 'ALL' | 10 | Nombre d'articles à afficher par page dans la liste. Utilisez 'ALL' pour afficher tous les articles sur une page de liste. |
blogListComponent | string | '@theme/BlogListPage' | Composant racine de la page de liste du blog. |
blogPostComponent | string | '@theme/BlogPostPage' | Composant racine de chaque page d'article du blog. |
blogTagsListComponent | string | '@theme/BlogTagsListPage' | Composant racine de la page de la liste des tags. |
blogTagsPostsComponent | string | '@theme/BlogTagsPostsPage' | Composant racine de la page « articles contenant le tag ». |
blogArchiveComponent | string | '@theme/BlogArchivePage' | Composant racine de la page d'archive du blog. |
blogAuthorsPostsComponent | string | '@theme/Blog/Pages/BlogAuthorsPostsPage' | Root component of the blog author page. |
blogAuthorsListComponent | string | '@theme/Blog/Pages/BlogAuthorsListPage' | Root component of the blog authors page index. |
remarkPlugins | any[] | [] | Plugins Remark passés à MDX. |
rehypePlugins | any[] | [] | Plugins Rehype passés à MDX. |
recmaPlugins | any[] | [] | Recma plugins passed to MDX. |
beforeDefaultRemarkPlugins | any[] | [] | Les plugins Remark personnalisés sont transmis à MDX avant les plugins Remark par défaut de Docusaurus. |
beforeDefaultRehypePlugins | any[] | [] | Les plugins Rehype personnalisés sont transmis à MDX avant les plugins Rehype par défaut de Docusaurus. |
truncateMarker | RegExp | /<!--\s*truncate\s*-->/ | \{\/\*\s*truncate\s*\*\/\}/ | Marqueur de troncature marquant la fin du résumé. |
showReadingTime | boolean | true | Affiche le temps de lecture estimé pour l'article du blog. |
readingTime | ReadingTimeFn | Le temps de lecture par défaut | Un callback pour personnaliser le nombre du temps de lecture affiché. |
authorsMapPath | string | 'authors.yml' | Chemin vers le fichier map des auteurs, relatif au répertoire de contenu du blog. |
feedOptions | Voir ci-dessous | {type: ['rss', 'atom']} | Flux du blog. |
feedOptions.type | FeedType | FeedType[] | 'all' | null | Obligatoire | Type de flux à générer. Utilisez null pour désactiver la génération. |
feedOptions.createFeedItems | CreateFeedItemsFn | undefined | undefined | Une fonction optionnelle qui peut être utilisée pour transformer et / ou filtrer les éléments du flux. |
feedOptions.limit | number | null | false | 20 | Limite le flux au nombre spécifié d'articles, false ou null pour avoir toutes les entrées. Par défaut, |