From 11c9797757329a724ffab88e556b16fd5bb52889 Mon Sep 17 00:00:00 2001 From: "Zimin A.N." Date: Fri, 8 May 2026 09:09:51 +0300 Subject: [PATCH] =?UTF-8?q?feat(docs):=20=D0=B2=D0=B5=D1=80=D0=BD=D1=83?= =?UTF-8?q?=D1=82=D1=8C=20YFM=20tabs=20syntax=20+=20bundle=20runtime=20ass?= =?UTF-8?q?ets?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Diplodoc CLI 4.60 транформирует `{% list tabs %}` встроенным плагином, но runtime assets (`_assets/tabs-extension.{js,css}`) НЕ копирует автоматически — в отличие от mermaid/latex/page-constructor, у которых bundle paths захардкожены в CLI. Решение: - добавил devDep `@diplodoc/tabs-extension@^3` (содержит runtime/) - post-build `copy-tabs-runtime` script: копирует `build/runtime/index.{js,css}` → `_dist/_assets/tabs-extension.{js,css}` - index.md: 4 секции "С чего начать" обёрнуты в `{% list tabs %}` — выглядит компактнее и интерактивнее чем плоский список заголовков Verified локально: `yfm-tabs` HTML рендерится, assets в `_dist/_assets/`. nginx fallback rule для `/docs/_assets/*` уже работает. --- docs/index.md | 46 ++++++++++++++++++++++++--------------------- docs/package.json | 6 ++++-- docs/pnpm-lock.yaml | 3 +++ 3 files changed, 32 insertions(+), 23 deletions(-) diff --git a/docs/index.md b/docs/index.md index 0923191..cb14627 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,36 +7,40 @@ **Anchor v1 — production LIVE на cluster.142** (с 2026-05-07). Альтум consumers подключены, blue/green cutover завершён. -## Что внутри +## С чего начать -### Я интегрирую свой сервис +{% list tabs %} -Начни с [обзора API](integration/api/index.md) и [авторизации](integration/api/auth.md). +- Я интегрирую свой сервис -Дальше: -- [Read-side endpoints](integration/api/read-endpoints.md) — как читать справочники -- [События (Kafka outbox)](integration/api/events.md) — топики `ordinis.cuod.events.*` -- [Webhooks](integration/api/webhooks.md) — push-уведомления вместо polling -- [Кэширование](integration/api/caching.md) — TTL / push / snapshot стратегии + Начни с [обзора API](integration/api/index.md) и [авторизации](integration/api/auth.md). -### Я строю UI / клиент + Дальше: + - [Read-side endpoints](integration/api/read-endpoints.md) — как читать справочники + - [События (Kafka outbox)](integration/api/events.md) — топики `ordinis.cuod.events.*` + - [Webhooks](integration/api/webhooks.md) — push-уведомления вместо polling + - [Кэширование](integration/api/caching.md) — TTL / push / snapshot стратегии -- [Cross-references](integration/api/x-references.md) — FK между справочниками -- [Bitemporal](integration/api/bitemporal.md) — `validFrom` / `validTo` + история -- [Bundle cuod](integration/api/bundle-cuod.md) — список 40 справочников ЦУОД -- [Best practices](integration/api/best-practices.md) — частые ошибки +- Я строю UI / клиент -### Я обрабатываю ошибки + - [Cross-references](integration/api/x-references.md) — FK между справочниками + - [Bitemporal](integration/api/bitemporal.md) — `validFrom` / `validTo` + история + - [Bundle cuod](integration/api/bundle-cuod.md) — список 40 справочников ЦУОД + - [Best practices](integration/api/best-practices.md) — частые ошибки -- [Ошибки и rate limits](integration/api/errors.md) — error codes, retry strategy -- [Лучшие практики](integration/api/best-practices.md) — robust integration +- Я обрабатываю ошибки -### Я хочу пощупать API + - [Ошибки и rate limits](integration/api/errors.md) — error codes, retry strategy + - [Лучшие практики](integration/api/best-practices.md) — robust integration -Открой [Swagger UI](https://ordinis.k8s.264.nstart.cloud/swagger-ui.html) — -там можно нажать **Authorize** → войти через Keycloak (PKCE, без secret) → -и сразу делать "Try it out" с реальным JWT. Authorization, error codes, -schemas — всё через interactive UI. +- Я хочу пощупать API + + Открой [Swagger UI](https://ordinis.k8s.264.nstart.cloud/swagger-ui.html) — + там можно нажать **Authorize** → войти через Keycloak (PKCE, без secret) → + и сразу делать "Try it out" с реальным JWT. Authorization, error codes, + schemas — всё через interactive UI. + +{% endlist %} ## Среды diff --git a/docs/package.json b/docs/package.json index b00648a..75cdfad 100644 --- a/docs/package.json +++ b/docs/package.json @@ -5,14 +5,16 @@ "description": "Ordinis НСИ ЦУОД ОДХ — техническая документация (Diplodoc / YFM)", "scripts": { "prebuild": "rm -rf ./_dist", - "build": "yfm build -i . -o ./_dist --output-format html", + "build": "yfm build -i . -o ./_dist --output-format html && pnpm copy-tabs-runtime", + "copy-tabs-runtime": "mkdir -p ./_dist/_assets && cp node_modules/@diplodoc/tabs-extension/build/runtime/index.js ./_dist/_assets/tabs-extension.js && cp node_modules/@diplodoc/tabs-extension/build/runtime/index.css ./_dist/_assets/tabs-extension.css", "build:md": "yfm build -i . -o ./_dist --output-format md", "serve": "npx serve ./_dist -p 8088", "dev": "pnpm build && pnpm serve", "clean": "rm -rf ./_dist" }, "devDependencies": { - "@diplodoc/cli": "^4.50.0" + "@diplodoc/cli": "^4.50.0", + "@diplodoc/tabs-extension": "^3" }, "packageManager": "pnpm@9.0.0" } diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml index ead1c97..81aaf6a 100644 --- a/docs/pnpm-lock.yaml +++ b/docs/pnpm-lock.yaml @@ -11,6 +11,9 @@ importers: '@diplodoc/cli': specifier: ^4.50.0 version: 4.60.0(@types/markdown-it@13.0.9)(markdown-it@13.0.2) + '@diplodoc/tabs-extension': + specifier: ^3 + version: 3.10.0 packages: