Aller au contenu

@astrojs/ mdx

v2.1.1 GitHub npm Changelog

Cette intégration Astro permet d’utiliser les composants MDX et de créer des pages sous forme de fichiers .mdx.

Pourquoi MDX ?

Titre de la section Pourquoi MDX ?

MDX vous permet d’utiliser des variables, des expressions JSX et des composants dans du contenu Markdown dans Astro. Si vous avez du contenu existant rédigé en MDX, cette intégration vous permet d’intégrer ces fichiers à votre projet Astro.

Installation

Titre de la section Installation

Astro inclut une commande astro add pour automatiser l’installation des intégrations officielles. Si vous préférez, vous pouvez installer les intégrations manuellement à la place.

Exécutez l’une des commandes suivantes dans une nouvelle fenêtre de terminal.

Fenêtre de terminal
npx astro add mdx

Si vous rencontrez des problèmes, n’hésitez pas à nous les signaler sur GitHub et essayez les étapes d’installation manuelle ci-dessous.

Installation manuelle

Titre de la section Installation manuelle

Tout d’abord, installez le paquet @astrojs/mdx :

Fenêtre de terminal
npm install @astrojs/mdx

Ensuite, appliquez l’intégration à votre fichier astro.config.* en utilisant la propriété integrations :

astro.config.mjs
import { defineConfig } from 'astro/config';
import mdx from '@astrojs/mdx';


export default defineConfig({
  // ...
  integrations: [mdx()],
});

Intégration dans un éditeur

Titre de la section Intégration dans un éditeur

Pour la prise en charge de l’éditeur dans VS Code, installez l’extension MDX officielle.

Pour les autres éditeurs, utilisez le serveur de langage MDX.

Utilisation

Titre de la section Utilisation

Avec l’intégration MDX d’Astro, vous pouvez ajouter des pages MDX à votre projet en ajoutant des fichiers .mdx dans votre répertoire src/pages/. Vous pouvez également importer des fichiers .mdx dans des fichiers .astro.

L’intégration MDX d’Astro ajoute des fonctionnalités supplémentaires au MDX standard, y compris un texte frontal de style Markdown. Cela vous permet d’utiliser la plupart des fonctionnalités Markdown intégrées d’Astro comme une propriété layout spéciale de frontmatter.

Regardez comment MDX fonctionne dans Astro avec des exemples dans notre Guide Markdown & MDX.

Visitez la documentation MDX pour apprendre à utiliser les fonctions MDX standard.

Configuration

Titre de la section Configuration

Une fois l’intégration MDX installée, aucune configuration n’est nécessaire pour utiliser les fichiers .mdx dans votre projet Astro.

Vous pouvez configurer le rendu de votre MDX à l’aide des options suivantes :

Options héritées de la configuration Markdown

Titre de la section Options héritées de la configuration Markdown

Toutes les options de configuration markdown peuvent être configurées séparément dans l’intégration MDX. Cela inclut les plugins remark et rehype, la coloration syntaxique, et plus encore. Les options seront par défaut celles de votre configuration Markdown (voir l’option extendMarkdownConfig pour les modifier).

astro.config.mjs
import { defineConfig } from 'astro/config';
import mdx from '@astrojs/mdx';
import remarkToc from 'remark-toc';
import rehypeMinifyHtml from 'rehype-minify-html';


export default defineConfig({
  // ...
  integrations: [
    mdx({
      syntaxHighlight: 'shiki',
      shikiConfig: { theme: 'dracula' },
      remarkPlugins: [remarkToc],
      rehypePlugins: [rehypeMinifyHtml],
      remarkRehype: { footnoteLabel: 'Footnotes' },
      gfm: false,
    }),
  ],
});
Voir la référence des options Markdown pour une liste complète des options.

extendMarkdownConfig

Titre de la section extendMarkdownConfig
  • Type: boolean
  • Default: true

MDX étend par défaut la configuration Markdown existante de votre projet. Pour remplacer certaines options, vous pouvez spécifier leur équivalent dans votre configuration MDX.

Par exemple, disons que vous avez besoin de désactiver GitHub-Flavored Markdown et d’appliquer un ensemble différent de plugins de remark pour les fichiers MDX. Vous pouvez appliquer ces options comme suit, avec extendMarkdownConfig activée par défaut :

astro.config.mjs
import { defineConfig } from 'astro/config';
import mdx from '@astrojs/mdx';


export default defineConfig({
  // ...
  markdown: {
    syntaxHighlight: 'prism',
    remarkPlugins: [remarkPlugin1],
    gfm: true,
  },
  integrations: [
    mdx({
      // `syntaxHighlight` héritée de Markdown


      // Markdown `remarkPlugins` ignorée,
      // seulement `remarkPlugin2` est appliquée.
      remarkPlugins: [remarkPlugin2],
      // `gfm` remplacée par `false`
      gfm: false,
    }),
  ],
});

Vous pouvez également avoir besoin de désactiver l’extension de la configuration markdown dans MDX. Pour cela, mettez extendMarkdownConfig à false :

astro.config.mjs
import { defineConfig } from 'astro/config';
import mdx from '@astrojs/mdx';


export default defineConfig({
  // ...
  markdown: {
    remarkPlugins: [remarkPlugin1],
  },
  integrations: [
    mdx({
      // La configuration Markdown est désormais ignorée
      extendMarkdownConfig: false,
      // Pas de `remarkPlugins` appliquée
    }),
  ],
});

recmaPlugins

Titre de la section recmaPlugins

Il s’agit de plugins qui modifient directement la sortie estree. Ceci est utile pour modifier ou injecter des variables JavaScript dans vos fichiers MDX.

Nous vous suggérons d’utiliser AST Explorer pour jouer avec les sorties d’estree, et d’essayer estree-util-visit pour effectuer des recherches dans les nœuds JavaScript.

optimize

Titre de la section optimize
  • Type: boolean | { customComponentNames?: string[] }

Il s’agit d’un paramètre de configuration facultatif qui permet d’optimiser la sortie MDX pour une construction et un rendu plus rapides grâce à un plugin rehype interne. Cela peut être utile si vous avez beaucoup de fichiers MDX et que vous constatez des lenteurs dans la construction. Cependant, cette option peut générer du HTML non échappé, assurez-vous donc que les parties interactives de votre site fonctionnent toujours correctement après l’avoir activée.

Cette option est désactivée par défaut. Pour activer l’optimisation MDX, ajoutez ce qui suit à votre configuration d’intégration MDX :

astro.config.mjs
import { defineConfig } from 'astro/config';
import mdx from '@astrojs/mdx';


export default defineConfig({
  // ...
  integrations: [
    mdx({
      optimize: true,
    }),
  ],
});

customComponentNames

Titre de la section customComponentNames
  • Type: string[]

Une propriété optionnelle de optimize pour empêcher l’optimisateur MDX de gérer tout composant personnalisé passé au contenu MDX importé via la propriété components.

Vous devrez exclure ces composants de l’optimisation, car l’optimisateur convertit trop rapidement le contenu en une chaîne statique, ce qui brisera les composants personnalisés qui ont besoin d’être rendus dynamiquement.

Par exemple, la sortie MDX prévue pour ce qui suit est <Heading>...</Heading> à la place de chaque "<h1>...</h1>" :

---
import { Content, components } from '../content.mdx';
import Heading from '../Heading.astro';
---


<Content components={{ ...components, h1: Heading }} />

Pour configurer l’optimisation à l’aide de la propriété customComponentNames, spécifiez un tableau de noms d’éléments HTML qui doivent être traités comme des composants personnalisés :

astro.config.mjs
import { defineConfig } from 'astro/config';
import mdx from '@astrojs/mdx';


export default defineConfig({
  // ...
  integrations: [
    mdx({
      optimize: {
        // Empêcher l'optimisateur de traiter les éléments `h1`.
        // Ceux-ci seront traités comme des composants personnalisés
        customComponentNames: ['h1'],
      },
    }),
  ],
});

Notez que si votre fichier MDX configure les composants personnalisés en utilisant export const components = { ... }, alors vous n’avez pas besoin de configurer manuellement cette option. L’optimisateur les détectera automatiquement.

Exemples

Titre de la section Exemples

Plus d'intégrations

Framework d'interface utilisateur

Adaptateurs SSR

Autres intégrations