Guía de migración
¿Cambias desde otra plataforma de documentación? Jamdesk puede ayudarte a automatizar la transición, o puedes migrar manualmente para tener control total.
¿Cambias desde Mintlify, GitBook, Docusaurus, ReadMe u otra plataforma? La pestaña de Mintlify cubre la migración automatizada con CLI. Todo lo demás es un proceso manual, pero es sencillo si tu contenido ya está en Markdown.
Markdown ofrece los mejores resultados. Si tu plataforma actual admite exportación en Markdown, úsala. Jamdesk está construido sobre MDX, por lo que el contenido en Markdown migra sin problemas.
Elige tu ruta
El CLI de Jamdesk puede convertir automáticamente proyectos de Mintlify.
Migración automatizada
npm install -g jamdeskjamdesk migrateEsto lee tu mint.json, lo convierte a docs.json y reescribe la sintaxis de componentes donde sea necesario.
Comprueba el docs.json generado y los archivos MDX. El CLI maneja la mayoría de las conversiones, pero deberías verificar el uso de componentes y la estructura de navegación.
Correspondencia de configuración
El CLI convierte mint.json a docs.json automáticamente. Estas son las diferencias clave para que puedas verificar el resultado.
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"] }
]
}
}Compatibilidad de componentes
La mayoría de los componentes de Mintlify tienen equivalentes directos en Jamdesk. Algunos tienen nombres o sintaxis diferentes.
| Componente Mintlify | Equivalente Jamdesk | Notas |
|---|---|---|
<Card> | <Card> | Misma sintaxis |
| CardGroup | <Columns> | Usa la prop cols para el número de columnas |
<Columns> | <Columns> | Misma sintaxis |
<Accordion> | <Accordion> | Misma sintaxis |
<Tabs> / <Tab> | <Tabs> / <Tab> | Misma sintaxis |
<Steps> / <Step> | <Steps> / <Step> | Misma sintaxis |
<CodeGroup> | <CodeGroup> | Misma sintaxis |
<Tip>, <Note>, <Warning> | <Tip>, <Note>, <Warning> | Misma sintaxis |
<ResponseField> | <ParamField> | Nombre diferente |
<Snippet> | Importar desde /snippets/ | Enfoque diferente |
Problemas comunes
Renombra CardGroup a <Columns>. La prop cols funciona igual. El CLI jamdesk migrate gestiona esto, pero comprueba los archivos que hayas editado manualmente.
Renombra <ResponseField> a <ParamField>. Las props se mantienen igual.
{/* Before */}
<ResponseField name="id" type="string" required>
The unique identifier
</ResponseField>
{/* After */}
<ParamField name="id" type="string" required>
The unique identifier
</ParamField>Mintlify usa un componente <Snippet>. En Jamdesk, utiliza importaciones MDX estándar desde un directorio /snippets/.
{/* Before (Mintlify) */}
<Snippet file="my-snippet.mdx" />
{/* After (Jamdesk) */}
import MySnippet from '/snippets/my-snippet.mdx'
<MySnippet />topbarLinks y topbarCtaButton de Mintlify se corresponden con navbar.links en docs.json. El campo name se convierte en label, y url se convierte en href.