Skip to content

Commit f3aea7c

Browse files
committed
Update OpenAPI documentation
1 parent 2096f5d commit f3aea7c

6 files changed

Lines changed: 45 additions & 9 deletions

File tree

docmd-main/v07/de/navigation.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,10 @@
234234
"title": "LLMs",
235235
"path": "/plugins/llms"
236236
},
237+
{
238+
"title": "OpenAPI",
239+
"path": "/plugins/openapi"
240+
},
237241
{
238242
"title": "Mermaid",
239243
"path": "/plugins/mermaid"

docmd-main/v07/de/plugins/openapi.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ description: "Rendert OpenAPI 3.x API-Referenzdokumentation direkt aus JSON- ode
55

66
Das **OpenAPI-Plugin** wandelt OpenAPI 3.x Spezifikationsdateien in strukturierte API-Referenzseiten um — zur Build-Zeit gerendert, ohne clientseitiges JavaScript und ohne Drittanbieter-Abhängigkeiten. Jeder Endpunkt, Parameter, Request-Body und jede Response wird in semantische HTML-Tabellen konvertiert.
77

8-
::: callout info "Optionales Plugin"
9-
Das OpenAPI-Plugin ist **nicht** in `@docmd/core` enthalten. Installieren Sie es separat, wenn Sie API-Dokumentation neben Ihrem Markdown-Inhalt einbetten müssen. Kein Swagger UI oder Redoc — das Plugin liest Ihre Spezifikation und gibt sauberes, zugängliches HTML zur Build-Zeit aus.
8+
::: callout info "Kern-Plugin"
9+
Das OpenAPI-Plugin ist jetzt standardmäßig in `@docmd/core` **enthalten**. Eine separate Installation ist nicht erforderlich. Es folgt der Docmd-Philosophie des Build-Zeit-Renderings — das Plugin liest Ihre Spezifikation und gibt saubere, zugängliche HTML-Tabellen ohne clientseitiges JavaScript aus.
1010
:::
1111

1212
## Installation
@@ -32,11 +32,19 @@ export default defineConfig({
3232
Betten Sie eine OpenAPI-Spezifikation in jede Markdown-Seite ein, indem Sie einen umzäunten Codeblock mit dem `openapi`-Sprach-Tag verwenden:
3333

3434
````markdown
35+
### Live-Beispiel
36+
3537
```openapi
36-
./api/openapi.json
38+
assets/docmd-api.json
3739
```
3840
````
3941

42+
### Ergebnis
43+
44+
```openapi
45+
assets/docmd-api.json
46+
```
47+
4048
Der Pfad wird relativ zu Ihrem `src`-Verzeichnis aufgelöst. Sowohl **JSON** als auch **YAML**-Formate werden unterstützt. YAML erfordert die Installation von `js-yaml`:
4149

4250
```bash

docmd-main/v07/en/navigation.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,10 @@
238238
"title": "LLMs",
239239
"path": "/plugins/llms"
240240
},
241+
{
242+
"title": "OpenAPI",
243+
"path": "/plugins/openapi"
244+
},
241245
{
242246
"title": "Mermaid",
243247
"path": "/plugins/mermaid"

docmd-main/v07/en/plugins/openapi.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ description: "Render OpenAPI 3.x API reference documentation directly from JSON
55

66
The **OpenAPI plugin** turns OpenAPI 3.x specification files into structured API reference pages - rendered at build time with no client-side JavaScript and no third-party dependencies. Every endpoint, parameter, request body, and response is converted to semantic HTML tables.
77

8-
::: callout info "Optional Plugin"
9-
The OpenAPI plugin is **not** bundled with `@docmd/core`. Install it separately when you need to embed API documentation alongside your Markdown content. No Swagger UI or Redoc is involved - the plugin reads your spec and outputs clean, accessible HTML at build time.
8+
::: callout info "Core Plugin"
9+
The OpenAPI plugin is **included** by default in `@docmd/core`. There is no need to install it separately. It follows the Docmd philosophy of build-time rendering - the plugin reads your spec and outputs clean, accessible HTML tables with zero client-side JavaScript.
1010
:::
1111

1212
## Installation
@@ -32,11 +32,19 @@ export default defineConfig({
3232
Embed an OpenAPI spec in any Markdown page using a fenced code block with the `openapi` language tag:
3333

3434
````markdown
35+
### Live Example
36+
3537
```openapi
36-
./api/openapi.json
38+
assets/docmd-api.json
3739
```
3840
````
3941

42+
### Result
43+
44+
```openapi
45+
assets/docmd-api.json
46+
```
47+
4048
The path is resolved relative to your `src` directory. Both **JSON** and **YAML** formats are supported. YAML requires `js-yaml` to be installed:
4149

4250
```bash

docmd-main/v07/zh/navigation.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,10 @@
234234
"title": "LLMs",
235235
"path": "/plugins/llms"
236236
},
237+
{
238+
"title": "OpenAPI",
239+
"path": "/plugins/openapi"
240+
},
237241
{
238242
"title": "Mermaid 图表",
239243
"path": "/plugins/mermaid"

docmd-main/v07/zh/plugins/openapi.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ description: "直接在 Markdown 页面中从 JSON 或 YAML 规范文件渲染 O
55

66
**OpenAPI 插件**将 OpenAPI 3.x 规范文件转换为结构化的 API 参考页面——在构建时渲染,无需客户端 JavaScript,无需第三方依赖。每个端点、参数、请求体和响应都转换为语义化 HTML 表格。
77

8-
::: callout info "可选插件"
9-
OpenAPI 插件**** `@docmd/core` 捆绑。当您需要在 Markdown 内容旁边嵌入 API 文档时,请单独安装。不涉及 Swagger UI 或 Redoc——插件在构建时读取规范并输出干净的静态 HTML。
8+
::: callout info "核心插件"
9+
OpenAPI 插件现在已**内置** `@docmd/core` 中,无需单独安装。它遵循 Docmd 的构建时渲染理念——插件在构建时读取您的规范并输出干净、可访问的 HTML 表格,无需客户端 JavaScript
1010
:::
1111

1212
## 安装
@@ -32,11 +32,19 @@ export default defineConfig({
3232
在任何 Markdown 页面中使用带 `openapi` 语言标签的围栏代码块嵌入 OpenAPI 规范:
3333

3434
````markdown
35+
### 实时示例
36+
3537
```openapi
36-
./api/openapi.json
38+
assets/docmd-api.json
3739
```
3840
````
3941

42+
### 渲染结果
43+
44+
```openapi
45+
assets/docmd-api.json
46+
```
47+
4048
路径相对于您的 `src` 目录解析。支持 **JSON****YAML** 格式。YAML 需要安装 `js-yaml`
4149

4250
```bash

0 commit comments

Comments
 (0)