Aller au contenu

Tape un mot pour chercher dans les pages.

↑↓ Choisir↵ OuvrirÉchap Fermer

Guides

Reprendre une doc Mintlify dans Docs, ce qui se reprend tel quel, ce qui change, et ce qui n'est pas encore disponible.

Le résultat : ta doc Mintlify tourne sous Docs, avec le même docs.json et les mêmes pages.

Avant de commencer : une copie de ta doc Mintlify dans un dossier à part, pour comparer.

Ce qui se reprend tel quel

  • Le docs.json : name, description, colors, logo, favicon, et navigation en groupes, onglets ou versions.
  • Les pages MDX et leurs métadonnées title, description et sidebarTitle.
  • Les composants de même nom : Note, Tip, Info, Warning, Danger, Check, Steps, Step, Tabs, Tab, CodeGroup, Card, CardGroup, Columns, Accordion, AccordionGroup et Frame. Leurs attributs sont décrits dans la référence des composants.

Ce qui change

  • Les champs que Docs ne gère pas sont acceptés et ignorés. Un champ Mintlify inconnu ne fait donc pas échouer le build.
  • Card et icon : l’attribut est accepté, mais l’icône ne s’affiche pas. Les icônes de Mintlify sont propriétaires.
  • Les images : range-les dans un dossier d’images ou dans public/, comme décrit dans Écrire une page.
  • Les liens s’écrivent depuis la racine de la doc, comme dans Mintlify.

Ce qui n’est pas encore disponible

  • navbar et logo.href : acceptés par la validation, mais ils ne s’affichent pas encore sur le site.
  • colors.light : accepté, sans effet. Seules colors.primary et colors.dark sont utilisées.
  • Les composants absents de la référence : Docs ne les connaît pas. Remplace-les par du Markdown ou par un composant de la liste.

Démarche conseillée

  1. Copie docs.json et les pages dans le dossier de Docs.
  2. Lance npm run dev et ouvre le site en local.
  3. Corrige les pages qui signalent une erreur : une page absente de la navigation, un chemin mal écrit.
  4. Vérifie les composants sur chaque page où tu en utilises.
  5. Quand le site est propre, suis Mettre ta doc en ligne.

Si ça ne marche pas

  • docs.json n'est pas un JSON valide : une virgule ou un guillemet. Le message donne la position.
  • navigation : utiliser une seule forme parmi versions, tabs, groups ou pages : tu as mélangé deux formes. Garde-en une.
  • docs.json cite des pages absentes du dossier : la liste donne les chemins introuvables.