Guide de migration
Vous migrez depuis une autre plateforme de documentation ? Jamdesk peut vous aider à automatiser la transition, ou vous pouvez migrer manuellement pour un contrôle total.
Vous passez de Mintlify, GitBook, Docusaurus, ReadMe ou une autre plateforme ? L'onglet Mintlify couvre la migration CLI automatisée. Tout le reste est un processus manuel, mais c'est simple si votre contenu est déjà en Markdown.
Le Markdown donne les meilleurs résultats. Si votre plateforme actuelle prend en charge l'export Markdown, utilisez-le. Jamdesk est construit sur MDX, donc le contenu Markdown migre proprement.
Choisissez votre chemin
La CLI Jamdesk peut convertir automatiquement les projets Mintlify.
Migration automatisée
npm install -g jamdeskjamdesk migrateCette commande lit votre mint.json, le convertit en docs.json et réécrit la syntaxe des composants si nécessaire.
Vérifiez le fichier docs.json généré et les fichiers MDX. La CLI gère la plupart des conversions, mais vous devez vérifier l'utilisation des composants et la structure de navigation.
Correspondance de configuration
La CLI convertit mint.json en docs.json automatiquement. Voici les principales différences pour vous permettre de vérifier le résultat.
Mintlify (mint.json) :
{
"name": "My Docs",
"navigation": [
{ "group": "Getting Started", "pages": ["introduction", "quickstart"] }
],
"colors": { "primary": "#0D9373" },
"topbarLinks": [{ "name": "Blog", "url": "https://example.com/blog" }]
}Jamdesk (docs.json) :
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"colors": { "primary": "#0D9373" },
"navbar": {
"links": [{ "label": "Blog", "href": "https://example.com/blog" }]
},
"navigation": {
"groups": [
{ "group": "Getting Started", "pages": ["introduction", "quickstart"] }
]
}
}Compatibilité des composants
La plupart des composants Mintlify ont des équivalents directs dans Jamdesk. Quelques-uns ont des noms ou une syntaxe différents.
| Composant Mintlify | Équivalent Jamdesk | Notes |
|---|---|---|
<Card> | <Card> | Même syntaxe |
| CardGroup | <Columns> | Utiliser la prop cols pour le nombre de colonnes |
<Columns> | <Columns> | Même syntaxe |
<Accordion> | <Accordion> | Même syntaxe |
<Tabs> / <Tab> | <Tabs> / <Tab> | Même syntaxe |
<Steps> / <Step> | <Steps> / <Step> | Même syntaxe |
<CodeGroup> | <CodeGroup> | Même syntaxe |
<Tip>, <Note>, <Warning> | <Tip>, <Note>, <Warning> | Même syntaxe |
<ResponseField> | <ParamField> | Nom différent |
<Snippet> | Import depuis /snippets/ | Approche différente |
Problèmes courants
Renommez CardGroup en <Columns>. La prop cols fonctionne de la même manière. La CLI jamdesk migrate gère cela, mais vérifiez les fichiers que vous avez modifiés manuellement.
Renommez <ResponseField> en <ParamField>. Les props restent identiques.
{/* Before */}
<ResponseField name="id" type="string" required>
The unique identifier
</ResponseField>
{/* After */}
<ParamField name="id" type="string" required>
The unique identifier
</ParamField>Mintlify utilise un composant <Snippet>. Dans Jamdesk, utilisez des imports MDX standard depuis un répertoire /snippets/.
{/* Before (Mintlify) */}
<Snippet file="my-snippet.mdx" />
{/* After (Jamdesk) */}
import MySnippet from '/snippets/my-snippet.mdx'
<MySnippet />Les champs topbarLinks et topbarCtaButton de Mintlify correspondent tous deux à navbar.links dans docs.json. Le champ name devient label, et url devient href.