Redirections

Lorsque vous modifiez le chemin d’un fichier dans votre dossier docs, l’URL de cette page change également. Cela peut se produire lors de la restructuration de votre documentation ou de la modification du titre de la barre latérale.

Les redirections ne peuvent pas inclure des ancres d’URL telles que path#anchor ni des paramètres de requête tels que path?query=value.

Configurez des redirections en ajoutant le champ redirects à votre fichier docs.json.

"redirects": [
  {
    "source": "/source/path",
    "destination": "/destination/path"
  }
]

Cela redirige /source/path vers /destination/path. Par défaut, les redirections sont permanentes (308). Pour utiliser une redirection temporaire (307), définissez permanent sur false.

"redirects": [
  {
    "source": "/source/path",
    "destination": "/destination/path",
    "permanent": false
  }
]

Les codes 307 et 308 conservent tous deux la méthode HTTP de la requête d’origine (contrairement à 301 et 302), ce qui les rend adaptés à la redirection des requêtes POST.

Redirections avec joker

Pour faire correspondre un chemin avec joker, utilisez * après un paramètre. Dans cet exemple, /beta/:slug* correspond à /beta/introduction et le redirige vers /v2/introduction.

"redirects": [
  {
    "source": "/beta/:slug*",
    "destination": "/v2/:slug*"
  }
]

Redirections avec jokers partiels

Utilisez des jokers partiels pour faire correspondre les segments d’URL qui commencent par un préfixe donné.

"redirects": [
  {
    "source": "/articles/concepts-*",
    "destination": "/collections/overview"
  }
]

Cela correspond à toutes les URL dont le chemin est /articles/concepts-, comme /articles/concepts-getting-started et /articles/concepts-overview, et les redirige toutes vers /collections/overview. Vous pouvez également réutiliser la valeur générique capturée dans la destination.

"redirects": [
  {
    "source": "/old/article-*",
    "destination": "/new/article-*"
  }
]

Cela redirige /old/article-123 vers /new/article-123, tout en conservant la valeur capturée après le préfixe.

Éviter les redirections infinies

Pour éviter les boucles infinies, ne créez pas de redirections circulaires dans lesquelles les chemins se renvoient les uns aux autres.

"redirects": [
  {
    "source": "/docs/:slug*",
    "destination": "/help/:slug*"
  },
  {
    "source": "/help/:slug*",
    "destination": "/docs/:slug*"
  }
]

Vérifier les liens cassés

Détectez les liens cassés avec la CLI.

mint broken-links

Contenu personnalisé

Journal des modifications

Prise en main

Organiser

Personnaliser

Créer du contenu

Documenter des API

Déployer

Optimisation

Redirections

Redirections

Redirections avec joker

Redirections avec jokers partiels

Éviter les redirections infinies

Vérifier les liens cassés

​Redirections

​Redirections avec joker

​Redirections avec jokers partiels

​Éviter les redirections infinies

​Vérifier les liens cassés

Redirections

Redirections avec joker

Redirections avec jokers partiels

Éviter les redirections infinies

Vérifier les liens cassés