Typemark Documentation

Με τον πράκτορα προγραμματισμού σας

Μεταφέρετε από Docusaurus, MkDocs, Fern, Nextra, Notion, Confluence ή ζωντανό ιστότοπο αναθέτοντας τη δουλειά στο Claude Code, Codex, Cursor ή Gemini. Ο πράκτορας ακολουθεί αυτόν τον οδηγό και ελέγχει τη δουλειά του με το typemark check.

Uuendatud 19. nov 20264 min lugemist

Για πλατφόρμες που το Typemark δεν εισάγει αυτόματα, ο πράκτορας προγραμματισμού σας κάνει τη μετατροπή. Η CLI του Typemark τον ξεκινά μέσα στον φάκελό σας, με αυτή τη σελίδα ως οδηγίες του, και ο πράκτορας συνεχίζει μέχρι το typemark check να περάσει.

Ο πράκτορας τρέχει στον υπολογιστή σας, με τη δική σας σύνδεση στον πάροχο του πράκτορα. Το περιεχόμενό σας δεν περνά από το Typemark μέχρι να το ανεβάσετε.

Εκτέλεση

  1. Εγκαταστήστε την CLI και τον πράκτορά σας

    npm install -g @gettypemark/cli

    Χρειάζεστε επίσης έναν από αυτούς τους πράκτορες εγκατεστημένο και συνδεδεμένο: Claude Code (claude), Codex (codex), CLI του Cursor (cursor-agent) ή Gemini CLI (gemini).

  2. Ξεκινήστε τη μεταφορά

    Δημιουργήστε έναν κενό φάκελο για τον νέο σας ιστότοπο και εκτελέστε τη μεταφορά από αυτόν, δείχνοντας το --source στα παλιά σας έγγραφα: έναν φάκελο, ένα αποθετήριο Git ή τη διεύθυνση του ζωντανού ιστότοπου.

    mkdir my-docs && cd my-docs
    typemark migrate --agent claude --source ../old-docs

    Χρησιμοποιήστε --agent codex, --agent cursor ή --agent gemini για τους άλλους. Προσθέστε --from gitbook, --from readme ή --from mintlify όταν ολοκληρώνετε μια από αυτές τις εισαγωγές.

  3. Ελέγξτε και δημοσιεύστε

    Όταν ολοκληρώσει ο πράκτορας, σας δείχνει τι δεν μεταφέρθηκε. Κάντε προεπισκόπηση του ιστότοπου με typemark dev και έπειτα δημοσιεύστε τον:

    typemark login
    typemark create "My Docs"    # δημιουργεί το έργο και συνδέει αυτόν τον φάκελο
    typemark push --prune --wait

Χρησιμοποιείτε άλλο πράκτορα; Εκτελέστε typemark migrate --guide για να εκτυπώσετε τις οδηγίες και επικολλήστε τις σε αυτόν.

Ο οδηγός που ακολουθεί ο πράκτορας

Το υπόλοιπο αυτής της σελίδας είναι γραμμένο για τον πράκτορα. Είναι επίσης μια καλή λίστα ελέγχου αν μεταφέρετε με το χέρι.

Στόχος

Μετατρέψτε τα αρχικά έγγραφα σε ιστότοπο Typemark στον τρέχοντα φάκελο: ένα typemark.json στη ρίζα και ένα αρχείο .mdx για κάθε σελίδα. Κρατήστε κάθε σελίδα, διατηρήστε τα URL των σελίδων όπου γίνεται, και ολοκληρώστε μόνο όταν το typemark check δεν αναφέρει σφάλματα.

Κανόνες

  • Ποτέ μην αλλάζετε την πηγή. Διαβάστε από το --source· γράψτε μόνο στον τρέχοντα φάκελο.
  • Χρησιμοποιήστε πρώτα το typemark migrate όταν η πηγή είναι Mintlify, GitBook ή ReadMe. Μετατρέπει το μεγαλύτερο μέρος του ιστότοπου· εσείς ολοκληρώνετε το υπόλοιπο.
  • Κρατήστε τα URL. Μια σελίδα στο /guides/auth του παλιού ιστότοπου πηγαίνει στο guides/auth.mdx. Όταν μια διαδρομή πρέπει να αλλάξει, προσθέστε ανακατεύθυνση στο typemark.json.
  • Μόνο περιεχόμενο. Το Typemark δεν εκτελεί ποτέ κώδικα από μια σελίδα. Αφαιρέστε τις δηλώσεις import και export, και μετατρέψτε τα προσαρμοσμένα React components και τις εκφράσεις JavaScript σε Markdown ή στα παρακάτω components. Κυριολεκτικές τιμές props, όπως το cols={3}, είναι εντάξει.
  • Μην εφευρίσκετε περιεχόμενο. Αντιγράψτε το κείμενο όπως είναι. Αν κάτι δεν μπορεί να μετατραπεί, αφήστε μια σύντομη σημείωση στην τελική αναφορά σας αντί να μαντέψετε.
  • Αποθηκεύστε πρώτα έναν ζωντανό ιστότοπο. Όταν η πηγή είναι URL, κατεβάστε κάθε σελίδα που χρειάζεστε σε έναν προσωρινό φάκελο πριν από τη μετατροπή και δουλέψτε από αυτά τα αρχεία.

Βήματα

  1. Απογραφή. Καταγράψτε κάθε σελίδα της πηγής και το URL της. Βρείτε την πλοήγηση: το sidebars.js (Docusaurus), το nav του mkdocs.yml (MkDocs), το docs.yml (Fern), τα αρχεία _meta.json (Nextra), την πλευρική μπάρα στο .vitepress/config (VitePress) ή τη δομή φακέλων μιας εξαγωγής.

  2. Γράψτε το typemark.json. Τα tabs περιέχουν ομάδες, οι ομάδες περιέχουν σελίδες, και μια σελίδα είναι η διαδρομή της χωρίς την επέκταση:

    {
      "$schema": "https://typemark.dev/schema.json",
      "name": "Acme Docs",
      "colors": { "primary": "#4f46e5" },
      "navigation": {
        "tabs": [
          {
            "tab": "Documentation",
            "groups": [
              { "group": "Getting started", "pages": ["introduction", "quickstart"] },
              { "group": "Guides", "pages": ["guides/auth", "guides/webhooks"] }
            ]
          },
          {
            "tab": "API Reference",
            "groups": [{ "group": "Endpoints", "pages": [{ "source": "openapi.yaml" }] }]
          }
        ]
      },
      "redirects": [{ "from": "/old-path", "to": "/new-path" }]
    }

    Οι ομάδες δεν μπαίνουν η μία μέσα στην άλλη: βάλτε τις σελίδες μιας υποενότητας στη δική της ομάδα, αμέσως μετά από την γονική της. Δείτε typemark.json και Navigation.

  3. Μετατρέψτε κάθε σελίδα σε .mdx με frontmatter. Το title είναι υποχρεωτικό· ο ιστότοπος το εμφανίζει ως επικεφαλίδα της σελίδας, άρα αφαιρέστε μια πρώτη επικεφαλίδα # Heading που το επαναλαμβάνει. Προσθέστε description όταν η πηγή έχει.

    ---
    title: Authentication
    description: Authenticate requests with an API key.
    ---
  4. Αντιστοιχίστε τα components με τον παρακάτω πίνακα.

  5. Μετακινήστε τις εικόνες στο images/ (ή κρατήστε τον φάκελό τους) και ενημερώστε τους συνδέσμους. Κατεβάστε τις εικόνες που φιλοξενούνται στους διακομιστές της παλιάς πλατφόρμας.

  6. Μετακινήστε τις μεταφράσεις, αν η πηγή έχει (όπως οι φάκελοι i18n/<locale>/ του Docusaurus): καταγράψτε τις γλώσσες στο languages του typemark.json, με την προεπιλεγμένη γλώσσα πρώτη, και βάλτε κάθε μεταφρασμένη σελίδα στο <code>/<page>.mdx, δηλαδή στην ίδια διαδρομή με τη σελίδα που μεταφράζει, μέσα σε φάκελο με το όνομα του κωδικού της γλώσσας. Μην προσθέτετε μεταφράσεις στην πλοήγηση. Δείτε Languages.

  7. Ελέγξτε με typemark check και διορθώστε κάθε σφάλμα. Επαναλάβετε μέχρι να περάσει. Κάντε προεπισκόπηση με typemark dev αν μπορείτε.

  8. Αναφέρετε τι δεν μεταφέρθηκε: σελίδες που παραλείφθηκαν, components που απλοποιήσατε, ανακατευθύνσεις που προσθέσατε.

Components

Στην πηγήΣτο Typemark
Admonitions: :::note, :::tip, :::warning, :::danger (Docusaurus, VitePress), !!! note (MkDocs), > [!NOTE] (GitHub)<Callout type="info">, type="tip", type="warning" ή type="danger". Προσθέστε title="…" για προσαρμοσμένο τίτλο
Tabs<Tabs> με παιδιά <Tab title="…">
Tabbed code blocks<CodeGroup> με ένα fenced block ανά καρτέλα, το καθένα με τίτλο: ```bash npm
Μπλοκ κώδικα με όνομα αρχείου```js title="index.js"
Συμπτυσσόμενες ενότητες, <details><Accordion title="…">· πολλές στη σειρά μπαίνουν σε <AccordionGroup>
Αριθμημένοι οδηγοί βημάτων<Steps> με παιδιά <Step title="…">
Κάρτες συνδέσμων και πλακίδια<Card title="…" icon="…" href="/path"> μέσα σε <CardGroup cols={2}>
Εικόνες με λεζάντες<Frame caption="…"><img src="/images/x.png" alt="…" /></Frame>
Παράμετροι API<ParamField query="name" type="string" required>, ή path, header ή body στη θέση του query
Πεδία απάντησης<ResponseField name="…" type="…">
Καταχωρίσεις αλλαγών<Update label="March 2026">
Badges<Badge>Beta</Badge>
Προδιαγραφές OpenAPIΑντιγράψτε την προδιαγραφή στον φάκελο και προσθέστε { "source": "openapi.yaml" } στην πλοήγηση
Οτιδήποτε άλλοΑπλό Markdown που διατηρεί το νόημα

Τα εικονίδια είναι ονόματα από το Heroicons, όπως το rocket-launch. Η πλήρης σύνταξη κάθε component βρίσκεται κάτω από MDX Components στην πλευρική μπάρα, για παράδειγμα Callouts και Cards.

Ολοκληρώθηκε όταν

  • Το typemark check δεν αναφέρει σφάλματα.
  • Κάθε σελίδα της απογραφής βρίσκεται στην πλοήγηση, έχει ανακατεύθυνση ή αναγράφεται στην αναφορά σας.
  • Ο φάκελος της πηγής δεν έχει αλλάξει.