Typemark Documentation

Agendivalmis dokumentatsioon

Iga Typemarki sait pakub Markdowni, llms.txt-faili ja MCP-serverit, nii et AI-tööriistad saavad su dokumentatsiooni lugeda samamoodi nagu inimesed.

Uuendatud 19. nov 20263 min lugemist

Su lugejad küsivad üha sagedamini AI-assistendilt enne, kui oma dokumentatsiooni avavad. Iga Typemarki sait on selleks valmis igal paketil ja ilma seadistamata: igal lehel on Markdowni versioon, saidil on llms.txt ja llms-full.txt, ning MCP-server laseb koodiredaktoritel dokumentatsioonis otse otsida ja seda lugeda.

Privaatne dokumentatsioon on erand: AI-tööriistad ei saa sisse logida, seega parooliga kaitstud saidil MCP-serverit ei ole ning selle Markdown ja llms.txt nõuavad parooli nagu kõik muu.

Allpool olevad näited kasutavad aadressi https://docs.acme.com. Asenda see oma saidi aadressiga: oma kohandatud domeeniga või {slug}.typemark.dev.

Iga lehe Markdown-versioon

Lisa mis tahes lehe URL-i lõppu .md, et saada leht Markdownina:

curl https://docs.acme.com/guides/authentication.md

Saad lehe pealkirja pealkirjana, kirjelduse tsitaadina ja lehe sisu ilma frontmatterita. Komponendid nagu <Callout> jäävad alles ning lingid viitavad saidi täielikele URL-idele.

Tööriistad, mis saadavad päise Accept: text/markdown, saavad tavalisest lehe URL-ist Markdowni. Iga HTML-leht viitab oma Markdown-versioonile ka Link päisega.

llms.txt ja llms-full.txt

FailMis selles on
/llms.txtSu saidi nimi ja kokkuvõte, seejärel loend kõigist lehtedest koos lingiga nende Markdown-versioonile ja kirjeldusega. Järgib llms.txt formaati.
/llms-full.txtKõigi lehtede Markdown ühes failis navigeerimisjärjekorras.

Kokkuvõtte rea võetakse väärtusest seo.default_description failis typemark.json. Lehed, mille frontmatteris on hidden: true, jäetakse mõlemast failist välja.

Neid faile võidakse vahemällu salvestada kuni tund aega, seega võib muudatuse nähtavaks saamine kesta sama kaua.

MCP-server

Igal saidil on kirjutuskaitstud MCP-server aadressil /mcp. Lisa see AI-tööriistale ja tööriist saab dokumentatsioonis töötades otsida ja seda lugeda. Sisselogimist ega API-võtit ei ole vaja.

https://docs.acme.com/mcp

Sellel on kolm tööriista:

TööriistMida ta teeb
search_docsOtsib su dokumentatsioonist ja tagastab kuni 10 sobivat lehte koos lühikese katkendiga igast
get_pageTagastab lehe Markdownina tee või URL-i järgi
list_pagesLoetleb kõik lehed navigeerimisjärjekorras koos nende tee ja kirjeldusega

Ühenda oma tööriistad

Lisa see faili ~/.cursor/mcp.json või projekti faili .cursor/mcp.json:

{
  "mcpServers": {
    "acme-docs": {
      "url": "https://docs.acme.com/mcp"
    }
  }
}

Lisa see faili .vscode/mcp.json oma tööruumis:

{
  "servers": {
    "acme-docs": {
      "type": "http",
      "url": "https://docs.acme.com/mcp"
    }
  }
}

Käivita see oma terminalis:

claude mcp add --transport http acme-docs https://docs.acme.com/mcp

Ava Claude's Customize > Connectors, vali Add custom connector ja kleebi serveri URL.

Lugejatel ei ole vaja seadistust ise kirjutada. Lehe toimingute menüü valik Connect to Cursor / VS Code / Claude kuvab need katkendid juba sinu saidi URL-iga.

Piirangud

Iga IP-aadress saab teha 60 MCP-päringut minutis ning iga sait teenindab kuni 600 päringut minutis.

Lehe toimingud

Igal avaldatud lehel on pealkirja kõrval nupp Copy page ja selle menüü AI-toimingutega:

ToimingMida ta teeb
Copy pageKopeerib lehe Markdownina, valmis kleepimiseks vestlusse
View as MarkdownAvab lehe .md versiooni
Open in ChatGPTAlustab ChatGPT vestlust, mis loeb lehe
Open in ClaudeAlustab Claude vestlust, mis loeb lehe
Connect to Cursor / VS Code / ClaudeKuvab sinu saidi MCP-seadistuse

Sisukorra all olev kaart Use these docs with AI pakub valikuid Connect via MCP ja Copy llms.txt link.

Lehe toimingud on vaikimisi sisse lülitatud. Nupu, menüü ja kaardi peitmiseks lülita Settings > Reader features all välja Page actions või sea see failis typemark.json:

"features": {
  "page_actions": false
}

Lehe toimingute väljalülitamine peidab need ainult lugejatelt. Markdown-lehed, llms.txt ja MCP-server jäävad kättesaadavaks.

Mida agendid näevad

AI-tööriistad saavad täpselt sama, mis lugejad:

  • Ainult avaldatud sisu. Režiimis käsitsi avaldamine ei jõua avaldamata muudatused Markdown-lehtedele, llms.txt-sse ega MCP-sse.
  • Midagi ei ole, kui sait on võrguühenduseta. Kui su sait on offline-režiimis, ei paku need pinnad sinu sisu.
  • Peidetud lehed jäävad nimekirjast välja. Lehed hidden: true jäetakse llms.txt-st, llms-full.txt-st ja MCP-serveri otsingust ning lehtede loendist välja. Nende Markdown-versioon on märgitud noindex.
  • Vaikekeel. Saidil mitmes keeles pakuvad llms.txt, llms-full.txt ja MCP-server vaikekeelt.
  • Eelvaateid ei ole. Eelvaate paigutustel ja haru eelvaadetel ei ole Markdown-lehti, llms.txt-i ega MCP-serverit.