Skip to main content

Docusaurus-ID-a-jeho-pouzitie

⬅ KNIFES – Prehľad • Zoznam • Detaily

GUID: 9e070810-b93a-46e3-89cc-ea0ec118e9df Status: backlog · Author: Roman Kazička · License: CC-BY-NC-SA-4.0

Čo je id v Docusauruse​

Každý dokument v Docusauruse má interný identifikátor (id), ktorý slúži ako trvalý odkaz na daný obsah. Tento id:

  • určuje jednoznačne dokument v rámci celej lokalizácie (napr. sk/knifes/K000001),
  • používa sa v konfiguráciách ako sidebars.ts, link komponenty, alebo redirects,
  • umožňuje stabilný routing aj po zmene názvu alebo presune súboru.

Ak dokument nemá explicitne definované id vo Front Matter, Docusaurus ho automaticky odvodení zo štruktúry priečinka a názvu súboru (napr. sk/knifes/moja-tema/index.md → sk/knifes/moja-tema).

Prečo je dôležité mať unikátne id​

Ak sa v projekte vyskytnú dve rovnaké id, Docusaurus nedokáže jednoznačne rozlíšiť, ktorý dokument sa má zobraziť — build potom skončí chybou:

The docs plugin found docs sharing the same id: "sk/knifes/KXXXXXXX"

Najlepšie praktiky​

  1. Každý KNIFE má mať svoj vlastný id vo formáte K000XXX podľa CSV indexu.
  2. Nepoužívaj rovnaké id medzi jazykmi (napr. SK a EN), ak dokumenty majú rôzny obsah.
  3. Ak potrebuješ dokument z procesu alebo šablóny, môžeš použiť dočasné id ako TMP-KNIFE-YYYYMMDD-XXX.
  4. Pre systémové dokumenty (napr. home, overview) možno použiť špeciálne id ako KNIFE_HOME, KNIFE_OVERVIEW.

Ako sa id používa v sidebaroch​

V súbore publishing/docusaurus/sidebars.ts sa dokumenty referencujú práve podľa id.
Príklad:

{
  type: 'doc',
  id: 'sk/knifes/K000088-docusaurus-id-a-jeho-pouzitie',
  label: 'Docusaurus ID a jeho použitie'
}

Ak v sidebaroch použiješ id, nemusíš sa obávať o presné cesty k súborom — Docusaurus si ich vyrieši sám.

Záver​

id je ako DNA každého dokumentu v Docusauruse.
Zaručuje stabilitu odkazov, jednoznačnosť v build procese a možnosť bezpečne reorganizovať dokumentáciu bez straty navigácie.