Typemark Documentation

Desde GitBook

Sincroniza tu espacio de GitBook con GitHub, importa el repositorio y revisa un commit que convierte los bloques de GitBook en componentes de Typemark. Tu Markdown, imágenes y redirecciones vienen contigo.

Actualizado el 19 nov 20264 min de lectura

GitBook puede escribir cada espacio en un repositorio de GitHub mediante Git Sync. Typemark importa ese repositorio: lee SUMMARY.md para tu navegación y convierte los bloques de GitBook, como {% hint %} y {% tabs %}, en componentes de Typemark.

A diferencia de una importación desde Mintlify, una importación desde GitBook sí modifica tus páginas, porque la sintaxis de bloques de GitBook solo se renderiza en GitBook. Todos los cambios llegan en un único commit, así que puedes revisarlos en GitHub y deshacerlos con Git.

Antes de empezar

  • Debes poder activar Git Sync para el espacio. Está disponible en los planes de GitBook que lo incluyen; consulta tu plan en GitBook.
  • El repositorio pesa 100 MB o menos y no tiene submódulos de Git.
  • Usa un repositorio nuevo y vacío para la sincronización. La importación hace commits en él, y no quieres que GitBook escriba en los mismos archivos después.

Importa tu espacio

  1. Sincroniza el espacio con GitHub

    En GitBook, abre el espacio, configura Git Sync con un repositorio nuevo de GitHub y elige la dirección GitBook → GitHub para la primera sincronización. La otra dirección reemplazaría tu espacio con el repositorio vacío.

  2. Crea un proyecto de Typemark

    Haz clic en New project, ponle un nombre y, en Start from, elige Import from GitHub. Haz clic en Create and connect GitHub y da a la GitHub App de Typemark acceso al repositorio.

  3. Elige el repositorio

    Typemark muestra GitBook space detected con el SUMMARY.md que encontró. Haz clic en Import y confirma.

  4. Revisa el commit de conversión

    Typemark escribe typemark.json, convierte cada página en un solo commit, lo sube a GitHub y construye tu sitio. La vista general del proyecto muestra el resumen de importación.

  5. Desactiva Git Sync en GitBook

    Desconecta Git Sync para el espacio para que GitBook deje de escribir en el repositorio.

  6. Publica el sitio

    Revisa la lista de verificación para publicar y después haz clic en Go live en Settings > Publishing.

¿Tienes varios espacios, idiomas o variantes? Sincroniza cada uno con su propio repositorio e impórtalo como proyecto de Typemark independiente. Si quieres publicar los idiomas como un solo sitio, coloca cada página traducida en una carpeta con el nombre de su código de idioma, en la misma ruta que la página que traduce, dentro de un mismo proyecto. Consulta Idiomas.

Así se ve la conversión

---
description: Install the SDK.
---

# Getting started

{% hint style="warning" %}
Node 18 or later is required.
{% endhint %}

{% tabs %}
{% tab title="npm" %}
```bash
npm i @acme/sdk
```
{% endtab %}
{% endtabs %}
---
title: Getting started
description: Install the SDK.
---

<Warning>
Node 18 or later is required.
</Warning>

<Tabs>
<Tab title="npm">
```bash
npm i @acme/sdk
```
</Tab>
</Tabs>

Qué se convierte

GitBookTypemark
Grupos de páginas de SUMMARY.md (## Group)Grupos en la navegación de typemark.json
Páginas anidadas en SUMMARY.mdPáginas en el mismo grupo, justo después de su padre, ya que los grupos de Typemark no se anidan
root de .gitbook.yamldocs_root, cuando el espacio no está en la raíz del repositorio
redirects de .gitbook.yamlredirects
Páginas listadas en SUMMARY.mdPáginas .mdx. Las páginas no listadas se dejan como están y se mencionan en el resumen
folder/README.mdfolder.mdx, para que /folder siga funcionando. El readme del espacio se convierte en la primera página, en /
SUMMARY.mdSe elimina: tu navegación ahora vive en typemark.json
El primer # Heading de una páginaEl title de la página en el frontmatter
Frontmatter description, hiddenSe conserva
{% hint style="info" %}<Info>
{% hint style="success" %}<Check>
{% hint style="warning" %}<Warning>
{% hint style="danger" %}<Danger>
{% hint style="tip" %}<Tip>
{% tabs %} y {% tab title="…" %}<Tabs> y <Tab title="…">
{% stepper %} y {% step %}<Steps> y <Step title="…">, con el título tomado del encabezado del paso
{% code title="…" %} alrededor de un bloque de códigoUn bloque de código con ese título
<details> y <summary><Accordion title="…">
{% columns %}<Columns>
Tablas de tarjetas (data-view="cards")<CardGroup> con una <Card> por fila
<figure> con leyenda<Frame caption="…">
{% embed url="…" %} de un vídeo de YouTube, Vimeo, Loom o WistiaUn <Video>, con la leyenda del embed
Cualquier otro {% embed url="…" %}, {% content-ref %}, {% page-ref %}, {% file %}Una tarjeta que enlaza a la misma dirección
{% openapi … path="…" method="…" %}Un bloque de endpoint <API>
Enlaces a otras páginas .mdEnlaces a la página de Typemark, desde la raíz del sitio
Archivos en .gitbook/assets/Se mueven a images/, actualizando todos los enlaces. Los nombres con espacios usan guiones
Contenido reutilizable {% include %}Se copia en cada página que lo usa
Expresiones space.vars y page.varsSe reemplazan por sus valores

No se traslada

  • Especificaciones OpenAPI a nivel de organización. Añade el archivo de especificación al repositorio y列alo en la navegación como una entrada { "source": "openapi.yaml" }. Consulta OpenAPI.
  • Autenticación de visitantes, integraciones y personalización del sitio que viven en la configuración de GitBook y no en el repositorio.
  • Bloques {% swagger %} se mantienen como texto y se listan. Genera las páginas de endpoints a partir del archivo de especificación.
  • Bloques que Typemark no reconoce se mantienen tal como están y se listan en el resumen, junto con las páginas que los usan.

Desde tu terminal

Para convertir un repositorio sincronizado en tu equipo:

cd my-gitbook-repo
typemark migrate             # detects the GitBook space and converts it, then offers to create the project and push it

Responde sí dos veces y tu sitio estará en Typemark, sin conexión hasta que lo publiques. En CI o con un agente de programación, usa typemark migrate --create "My Docs" --push en su lugar.

typemark migrate escribe los mismos cambios que la importación de GitHub. Haz commit o guarda tu trabajo antes, para poder revisar el resultado con git diff.

Con tu agente de programación

Para lo que quede, como bloques desconocidos o HTML personalizado, deja que tu agente de programación termine el trabajo:

typemark migrate --from gitbook --agent claude

Consulta Con tu agente de programación.