Métadonnées d'entête
Personnalisation des métadonnées d'entête
Docusaurus définit automatiquement les métadonnées de page utiles dans <html>
, <head>
et <body>
pour vous. Il est possible d'ajouter des métadonnées supplémentaires (ou de remplacer celles existantes) avec la balise <head>
dans les fichiers Markdown :
---
id: head-metadata
title: Métadonnées d'entête
---
<head>
<html className="some-extra-html-class" />
<body className="other-extra-body-class" />
<title>Titre personnalisé de métadonnées d'entête !</title>
<meta charSet="utf-8" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://docusaurus.io/docs/markdown-features/head-metadata" />
</head>
# Métadonnées d'entête
Mon texte
Cette déclaration <head>
a été ajoutée au doc courant Markdown, en tant que démo. Ouvrez les DevTools de votre navigateur et vérifiez comment les métadonnées de cette page ont été affectées.
Cette fonctionnalité s'appuie sur le composant Docusaurus <Head>
. Reportez-vous vers react-helmet pour une documentation exhaustive.
Les plugins de contenu (par exemple, docs et blog) fournissent des options de front matter comme description
, keywords
et image
, qui seront automatiquement appliquées à la fois à description
et og:description
, alors que vous devriez déclarer manuellement deux balises de métadonnées lorsque vous utilisez la balise <head>
.
Description de la page Markdown
Les métadonnées de description des pages Markdown peuvent être utilisées à d'autres endroits que dans les métadonnées d'entête. Par exemple, l'index de catégorie généré par le plugin docs utilise les métadonnées de description des fiches de doc.
Par défaut, la description est la première ligne pleine de contenu, avec quelques efforts pour la convertir en texte brut. Par exemple, le fichier suivant...
# Titre
Contenu principal... Peut contenir quelques [liens](./file.mdx) ou des **mises en évidence**.
... aura la description par défaut « Contenu principal... Peut contenir des liens ou des mises en évidence ». Cependant, il n'est pas conçu pour être entièrement fonctionnel. Lorsqu'il ne parvient pas à produire des descriptions raisonnables, vous pouvez en fournir une explicitement par le biais du frontmatter :
---
description: Cette description remplacera la valeur par défaut.
---
# Titre
Contenu principal... Peut contenir quelques [liens](./file.mdx) ou des **mises en évidence**.