Opensophy Hub: SSG/SPA pro Markdown dokumentaci

Opensophy Hub: statická SSG/SPA platforma pro rozšířenou Markdown dokumentaci

Opensophy Hub je hybridní platforma založená na SSG a SPA, určená k publikování technické dokumentace, článků a manuálů. Řeší úlohu ukládání obsahu s rozšířenými možnostmi Markdown bez nutnosti MDX nebo dalších pluginů. Struktura projektu se generuje přímo z filesystému v adresáři Docs/, kde složky určují navigaci: boční lišta, breadcrumbs a URL se formují automaticky.

Příklad struktury:

Docs/
├── welcome.md
├── [N][brain]Withtati{article}/
│   ├── [C][folder-code]Razrabotka{development}/
│   │   └── [A][layers]Vybor steka{webrendering}.md
│   └── [C][signal]Instrumenty{tools}/
│       └── [A][container]Obzor Dokploy{dokploy}.md

Tři úrovně hierarchie — sekce ([N]), kategorie ([C]), články ([A]) — zajišťují slug, ikony a názvy bez manuálního nastavení routingu. To usnadňuje údržbu a škálování obsahu pro middle/senior vývojáře.

Rozšířený Markdown bez závislostí

Hub přináší bohaté bloky přímo do standardních .md souborů: upozornění, karty, sloupce, krokovníky, diagramy, KaTeX vzorce a grafy z tabulek. Místo HTML značek s třídami se používají jednoduché syntaktické konstrukce.

Příklad upozornění v HTML:

<div class="alert alert-warning" role="alert">
  <strong>Ostorozhno!</strong> Udalyonnye cherez <code>rm</code> files not popadayut in korzinu.
</div>

V Hub:

:::caution
Udalyonnye cherez `rm` files not popadayut in korzinu.
:::

Kroková instrukce (krokovník):

:::steps
:::step[status=done] Installation
`npm install`
:::
:::step[status=active] Onstroyka
Fillte `.env`.
:::
:::step[status=pending] Run
`npm run dev`
:::
:::

Takové bloky se renderují nativně bez externích knihoven, což snižuje složitost buildů a zlepšuje výkon SPA režimu.

Interaktivní tabulky a UI playgroundy

Standardní Markdown tabulky se mění v interaktivní komponenty s filtry podle sloupců (multi-select), hledáním s zvýrazněním, skrýváním sloupců, fullscreen, drag-to-scroll a exportem do Markdown/Excel.

Navíc podporuje vložení live komponent UI knihovny jedním řádkem:

[uic:blur-text]

Uživatel může dynamicky měnit parametry — měřítko, barvu, animaci, rychlost — a sledovat výsledek v reálném čase. To je užitečné pro demonstraci komponent v dokumentaci bez samostatného playgroundu.

CMS panel pro úpravy

Vestavěný panel pro správu obsahu umožňuje editovat Markdown s live náhledem. Vytváření stránek, kategorií a sekcí probíhá v rozhraní bez restartů npm run dev nebo skriptů. Podpora všech formátů bloků zajišťuje workflow blízký plnohodnotné CMS, ale na bázi statické generace.

Výhody pro vývojáře:

• Automatická navigace z filesystému.
• Rozšířený Markdown bez pluginů a MDX.
• Interaktivní tabulky s filtry a exportem.
• Live playgroundy pro UI komponenty.
• CMS-like editor s náhledem.

Co je důležité

• Souborová struktura jako navigace: Plná automatizace routingu, breadcrumbs a boční lišty z prefixů [N], [C], [A].
• Nativní Markdown bloky: Upozornění, krokovníky, sloupce, KaTeX, grafy — bez závislostí.
• Interaktivita tabulek: Filtry, hledání, fullscreen, export do MD/Excel.
• UI playgroundy: Jeden řádek pro live demo komponent s parametry.
• CMS rozhraní: Editace s náhledem bez buildů.

— Editorial Team