Typemark Documentation

Iz GitBooki

Sünkroonige oma GitBooki ruumi GitHubi, impordi repositoorium ja vaata üle üks commit, mis muudab GitBooki plokid Typemarki komponentideks. Sinu Markdown, pildid ja ümbersuunamised tulevad kaasa.

Uuendatud 19. nov 20263 min lugemist

GitBook saab iga ruumi kirjutada GitHubi repositooriumisse Git Synci abil. Typemark impordib selle repositooriumi: loeb navigatsiooni jaoks SUMMARY.md faili ja teisendab GitBooki plokid, näiteks {% hint %} ja {% tabs %}, Typemarki komponentideks.

Erinevalt Mintlify impordist muudab GitBooki import sinu lehti, sest GitBooki plokisüntaks renderdub ainult GitBookis. Kõik muudatused jõuavad ühte commitisse, nii et saad need GitHubis üle vaadata ja Giti abil tagasi võtta.

Enne alustamist

  • Git Sync peab olema ruumi jaoks sisse lülitatud. See on saadaval GitBooki plaanides, mis seda sisaldavad; kontrolli oma plaani GitBookis.
  • Repositoorium on kuni 100 MB ja sellel ei ole Giti alammooduleid.
  • Kasuta sünkroonimiseks uut tühja repositooriumi. Import teeb sinna commite ja sa ei soovi, et GitBook hiljem samu faile kirjutaks.

Impordi oma ruum

  1. Sünkroonige ruum GitHubi

    Ava GitBookis ruum, seadista Git Sync uue GitHubi repositooriumiga ja vali esimeseks sünkroonimiseks suund GitBook → GitHub. Teine suund asendaks sinu ruumi tühja repositooriumiga.

  2. Loo Typemarki projekt

    Klõpsa New project, anna nimi ja vali Start from all Import from GitHub. Klõpsa Create and connect GitHub ning anna Typemarki GitHubi rakendusele juurdepääs repositooriumile.

  3. Vali repositoorium

    Typemark näitab GitBook space detected koos leitud SUMMARY.md failiga. Klõpsa Import ja kinnita.

  4. Vaata teisenduse commit üle

    Typemark kirjutab typemark.json faili, teisendab kõik lehed ühte commitisse, saadab selle GitHubi ja ehitab sinu saidi. Projekti ülevaade näitab impordi kokkuvõtet.

  5. Lülita GitBookis Git Sync välja

    Ühenda ruumi Git Sync lahti, et GitBook repositooriumisse kirjutamise lõpetaks.

  6. Mine avalikuks

    Käi läbi avaldamise kontrollnimekiri ja klõpsa seejärel Settings > Publishing all Go live.

Mitu ruumi, keelt või varianti? Sünkroonige igaüks eraldi repositooriumisse ja impordi igaüks eraldi Typemarki projektina. Kui soovid keeli avaldada ühe saidina, aseta iga tõlgitud leht kausta, mille nimi on keele kood, samale teele nagu lehel, mida see tõlgib, ühes projektis. Vaata Keeled.

Kuidas teisendus välja näeb

---
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>

Mis teisendatakse

GitBookTypemark
SUMMARY.md lehtede grupid (## Group)Grupid typemark.json navigatsioonis
SUMMARY.md pesastatud lehedLehed samas grupis, vahetult pärast vanemat, kuna Typemarki grupid ei pesastu
.gitbook.yaml rootdocs_root, kui ruum ei asu repositooriumi juurkaustas
.gitbook.yaml redirectsredirects
SUMMARY.md loetletud lehed.mdx lehed. Loetlemata lehed jäetakse nagu on ja nimetatakse kokkuvõttes
folder/README.mdfolder.mdx, et /folder jääks toimima. Ruumi readme muutub esimeseks lehuks aadressil /
SUMMARY.mdEemaldatakse: navigatsioon elab nüüd typemark.json failis
Lehe esimene # HeadingLehe title frontmatteris
description, hidden frontmatterSäilib
{% hint style="info" %}<Info>
{% hint style="success" %}<Check>
{% hint style="warning" %}<Warning>
{% hint style="danger" %}<Danger>
{% hint style="tip" %}<Tip>
{% tabs %} ja {% tab title="…" %}<Tabs> ja <Tab title="…">
{% stepper %} ja {% step %}<Steps> ja <Step title="…">, pealkiri võetakse sammu päisest
{% code title="…" %} koodiploki ümberKoodiplokk selle pealkirjaga
<details> ja <summary><Accordion title="…">
{% columns %}<Columns>
Kaartide tabelid (data-view="cards")<CardGroup> iga rea kohta <Card>
<figure> koos pealkirjaga<Frame caption="…">
{% embed url="…" %} YouTube'i, Vimeo, Loomi või Wistia video<Video> koos embedi pealkirjaga
Muu {% embed url="…" %}, {% content-ref %}, {% page-ref %}, {% file %}Kaart, mis viitab samale aadressile
{% openapi … path="…" method="…" %}<API> lõpp-punkti plokk
Lingid teistele .md lehtedeleLingid Typemarki lehele saidi juurest
Failid kaustas .gitbook/assets/Teisaldatakse kausta images/, iga link uuendatakse. Tühikuga nimed saavad kriipsud
{% include %} korduvkasutatav sisuKopeeritakse igale seda kasutavale lehele
space.vars ja page.vars avaldisedAsendatakse oma väärtustega

Ei kandu üle

  • Organisatsioonitasandi OpenAPI spetsifikatsioonid. Lisa spetsifikatsiooni fail repositooriumisse ja lisa see navigatsiooni kirjena { "source": "openapi.yaml" }. Vaata OpenAPI.
  • Külastajate autentimine, integratsioonid ja saidi kohandused, mis asuvad GitBooki seadetes, mitte repositooriumis.
  • {% swagger %} plokid jäävad tekstiks ja loetakse üles. Genereeri selle asemel lõpp-punktide lehed spetsifikatsiooni failist.
  • Plokid, mida Typemark ei tunne, jäävad nagu on ja loetakse kokkuvõttes üles koos lehtedega, mis neid kasutavad.

Terminalist

Sünkroonitud repositooriumi teisendamiseks oma arvutis:

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

Vasta kaks korda jah ja su sait on Typemarkis, võrguühenduseta kuni avaldamiseni. CI-s või koodiagendiga kasuta selle asemel typemark migrate --create "My Docs" --push.

typemark migrate kirjutab samad muudatused, mis GitHubi import. Commiti või peida enne oma töö, et tulemust saaks üle vaadata käsuga git diff.

Koodiagendiga

Ülejäänud osa, näiteks tundmatud plokid või kohandatud HTML, lase tööd lõpetada oma koodiagendil:

typemark migrate --from gitbook --agent claude

Vaata Koodiagendiga.