@clidey/dory 0.29.0 → 0.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/bin/dist/dory.js +115 -29
  2. package/bin/dist/dory.js.map +1 -1
  3. package/package.json +12 -4
  4. package/.dockerignore +0 -4
  5. package/CLAUDE.md +0 -178
  6. package/CODE_OF_CONDUCT.md +0 -128
  7. package/CONTRIBUTING.md +0 -91
  8. package/SECURITY.md +0 -11
  9. package/bin/dory.ts +0 -433
  10. package/dist/favicon.svg +0 -75
  11. package/dist/frontmatter.json +0 -77
  12. package/dist/index.html +0 -55
  13. package/dist/llms.txt +0 -561
  14. package/dist/logo/logo.svg +0 -18
  15. package/docs/api-playground-demo.mdx +0 -119
  16. package/docs/api-reference/asyncapi.json +0 -324
  17. package/docs/api-reference/openapi.json +0 -366
  18. package/docs/api-reference/operations/create.mdx +0 -5
  19. package/docs/api-reference/operations/delete.mdx +0 -5
  20. package/docs/api-reference/operations/get.mdx +0 -5
  21. package/docs/api-reference/operations/update.mdx +0 -5
  22. package/docs/api-reference/websocket-operations/receive-chat-message.mdx +0 -5
  23. package/docs/api-reference/websocket-operations/receive-notifications.mdx +0 -5
  24. package/docs/api-reference/websocket-operations/receive-presence-update.mdx +0 -5
  25. package/docs/api-reference/websocket-operations/send-chat-message.mdx +0 -5
  26. package/docs/api-reference/websocket-operations/send-presence-update.mdx +0 -5
  27. package/docs/dory.json +0 -64
  28. package/docs/favicon.svg +0 -75
  29. package/docs/features.mdx +0 -440
  30. package/docs/introduction.mdx +0 -44
  31. package/docs/logo/logo.svg +0 -18
  32. package/docs/websocket-playground-demo.mdx +0 -135
  33. package/index.html +0 -54
  34. package/scripts/generate-frontmatter-json.js +0 -154
  35. package/scripts/generate-llm-txt.js +0 -115
  36. package/src/app.css +0 -5
  37. package/src/app.tsx +0 -13
  38. package/src/components/dropdown.tsx +0 -53
  39. package/src/components/hooks.tsx +0 -28
  40. package/src/components/loading.tsx +0 -21
  41. package/src/components/mdx-provider.tsx +0 -13
  42. package/src/components/navigation.tsx +0 -58
  43. package/src/components/notification.tsx +0 -13
  44. package/src/components/routes.tsx +0 -92
  45. package/src/components/search-index.ts +0 -43
  46. package/src/components/search.tsx +0 -435
  47. package/src/components/store.ts +0 -216
  48. package/src/config/mdx.js +0 -12
  49. package/src/config/mdx.ts +0 -12
  50. package/src/main.tsx +0 -22
  51. package/src/mdx/accordion.tsx +0 -41
  52. package/src/mdx/api-playground.tsx +0 -659
  53. package/src/mdx/api.tsx +0 -354
  54. package/src/mdx/async-api.tsx +0 -353
  55. package/src/mdx/callout.tsx +0 -64
  56. package/src/mdx/card.tsx +0 -54
  57. package/src/mdx/code.tsx +0 -289
  58. package/src/mdx/expandable.tsx +0 -36
  59. package/src/mdx/fence.tsx +0 -74
  60. package/src/mdx/icon.tsx +0 -73
  61. package/src/mdx/latex.tsx +0 -26
  62. package/src/mdx/list.tsx +0 -7
  63. package/src/mdx/mdx.tsx +0 -47
  64. package/src/mdx/mermaid.tsx +0 -147
  65. package/src/mdx/open-api.tsx +0 -311
  66. package/src/mdx/processor.ts +0 -174
  67. package/src/mdx/source.tsx +0 -58
  68. package/src/mdx/step.tsx +0 -51
  69. package/src/mdx/table.tsx +0 -20
  70. package/src/mdx/tag.tsx +0 -53
  71. package/src/mdx/text.tsx +0 -99
  72. package/src/mdx/websocket-playground.tsx +0 -824
  73. package/src/plugins/docs-assets.ts +0 -79
  74. package/src/plugins/frontmatter-dev-server.ts +0 -158
  75. package/src/plugins/frontmatter-generator.ts +0 -157
  76. package/src/plugins/html-metadata-injector.ts +0 -76
  77. package/src/plugins/llm-txt-dev-server.ts +0 -183
  78. package/src/plugins/llm-txt-generator.ts +0 -186
  79. package/src/plugins/sanitize.ts +0 -163
  80. package/src/plugins/unified-mdx-plugin.ts +0 -35
  81. package/src/theme.scss +0 -72
  82. package/src/types/config.ts +0 -47
  83. package/src/ui/header.tsx +0 -91
  84. package/src/ui/layout.tsx +0 -226
  85. package/src/ui/mobile-navigation.tsx +0 -64
  86. package/src/ui/prev-next-link.tsx +0 -74
  87. package/src/ui/table-of-content.tsx +0 -166
  88. package/src/utils/colors.ts +0 -54
  89. package/src/utils/fonts.ts +0 -23
  90. package/src/utils/functions.ts +0 -12
  91. package/src/vite-env.d.ts +0 -1
  92. package/tsconfig.app.json +0 -33
  93. package/tsconfig.bin.json +0 -24
  94. package/tsconfig.json +0 -7
  95. package/tsconfig.node.json +0 -26
  96. package/vite.config.ts +0 -43
package/dist/frontmatter.json DELETED
@@ -1,77 +0,0 @@
1
- [
2
- {
3
- "title": "Introduction",
4
- "description": "Welcome to Docucod and Dory documentation",
5
- "path": "/introduction"
6
- },
7
- {
8
- "title": "Features",
9
- "description": "Overview of available components and features",
10
- "path": "/features"
11
- },
12
- {
13
- "title": "WebSocket Playground Demo",
14
- "description": "Interactive WebSocket playground for testing real-time connections",
15
- "path": "/websocket-playground-demo"
16
- },
17
- {
18
- "title": "POST /products",
19
- "description": "Create a new product",
20
- "openapi": "POST /products",
21
- "path": "/api-reference/operations/create"
22
- },
23
- {
24
- "title": "GET /products",
25
- "description": "Get a list of products",
26
- "openapi": "GET /products",
27
- "path": "/api-reference/operations/get"
28
- },
29
- {
30
- "title": "PUT /products/{id}",
31
- "description": "Update a product",
32
- "openapi": "PUT /products/{id}",
33
- "path": "/api-reference/operations/update"
34
- },
35
- {
36
- "title": "DELETE /products/{id}",
37
- "description": "Delete a product",
38
- "openapi": "DELETE /products/{id}",
39
- "path": "/api-reference/operations/delete"
40
- },
41
- {
42
- "title": "PUBLISH /chat",
43
- "description": "Send a chat message to other users",
44
- "asyncapi": "publish /chat",
45
- "path": "/api-reference/websocket-operations/send-chat-message"
46
- },
47
- {
48
- "title": "SUBSCRIBE /chat",
49
- "description": "Subscribe to receive chat messages from other users",
50
- "asyncapi": "subscribe /chat",
51
- "path": "/api-reference/websocket-operations/receive-chat-message"
52
- },
53
- {
54
- "title": "SUBSCRIBE /notifications",
55
- "description": "Subscribe to receive system notifications",
56
- "asyncapi": "subscribe /notifications",
57
- "path": "/api-reference/websocket-operations/receive-notifications"
58
- },
59
- {
60
- "title": "PUBLISH /presence",
61
- "description": "Send a presence update",
62
- "asyncapi": "publish /presence",
63
- "path": "/api-reference/websocket-operations/send-presence-update"
64
- },
65
- {
66
- "title": "SUBSCRIBE /presence",
67
- "description": "Subscribe to receive user presence updates",
68
- "asyncapi": "subscribe /presence",
69
- "path": "/api-reference/websocket-operations/receive-presence-update"
70
- },
71
- {
72
- "title": "API Playground Demo",
73
- "description": "Interactive API playground for testing HTTP endpoints",
74
- "openapi": "POST /plants",
75
- "path": "/api-playground-demo"
76
- }
77
- ]
package/dist/index.html DELETED
@@ -1,55 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8" />
5
- <link rel="icon" href="/assets/favicon-nLquwUQp.svg" />
6
- <meta name="viewport" content="width=device-width, initial-scale=1" />
7
- <meta name="theme-color" content="#000000" />
8
-
9
- <!-- Primary Meta Tags -->
10
- <meta name="description" content="Docucod - Technical Documentation" />
11
- <meta name="keywords" content="documentation, code documentation, auto documentation, developer tools, technical documentation, codebase documentation, llm, ai, anthropic, openai, chatgpt, claude, clidey" />
12
- <meta name="author" content="Clidey" />
13
- <meta name="language" content="English" />
14
-
15
- <!-- Open Graph / Facebook -->
16
- <meta property="og:title" content="Docucod" />
17
- <meta property="og:description" content="Docucod - Technical Documentation" />
18
- <meta property="og:image" content="/assets/favicon-nLquwUQp.svg" />
19
- <meta property="og:url" content="https://docucod.com/" />
20
- <meta property="og:type" content="website" />
21
- <meta property="og:site_name" content="Docucod" />
22
- <meta property="og:locale" content="en_US" />
23
-
24
- <!-- Twitter -->
25
- <meta name="twitter:card" content="summary_large_image" />
26
- <meta name="twitter:title" content="Docucod" />
27
- <meta name="twitter:description" content="Docucod - Technical Documentation" />
28
- <meta name="twitter:image" content="/assets/favicon-nLquwUQp.svg" />
29
- <meta name="twitter:site" content="@ClideyOfficial" />
30
- <meta name="twitter:creator" content="@ClideyOfficial" />
31
-
32
- <link rel="apple-touch-icon" href="/assets/favicon-nLquwUQp.svg" />
33
- <link rel="manifest" href="/manifest.json" />
34
-
35
- <title>Docucod</title>
36
-
37
- <link rel="preconnect" href="https://fonts.googleapis.com" />
38
- <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
39
- <link href="https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&family=Inter&display=swap" rel="stylesheet">
40
-
41
- <script>
42
- !function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.crossOrigin="anonymous",p.async=!0,p.src=s.api_host.replace(".i.posthog.com","-assets.i.posthog.com")+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="init be ys Ss me gs ws capture Ne calculateEventProperties xs register register_once register_for_session unregister unregister_for_session Rs getFeatureFlag getFeatureFlagPayload isFeatureEnabled reloadFeatureFlags updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures on onFeatureFlags onSurveysLoaded onSessionId getSurveys getActiveMatchingSurveys renderSurvey canRenderSurvey canRenderSurveyAsync identify setPersonProperties group resetGroups setPersonPropertiesForFlags resetPersonPropertiesForFlags setGroupPropertiesForFlags resetGroupPropertiesForFlags reset get_distinct_id getGroups get_session_id get_session_replay_url alias set_config startSessionRecording stopSessionRecording sessionRecordingStarted captureException loadToolbar get_property getSessionProperty Is ks createPersonProfile Ps bs opt_in_capturing opt_out_capturing has_opted_in_capturing has_opted_out_capturing clear_opt_in_out_capturing $s debug Es getPageViewId captureTraceFeedback captureTraceMetric".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
43
- posthog.init('phc_hxwfcMiIgSXYKkbWl9zpQE0HaPPmlRaVXCWODricYu1', {
44
- api_host: 'https://us.i.posthog.com',
45
- person_profiles: 'identified_only', // or 'always' to create profiles for anonymous users as well
46
- })
47
- </script>
48
- <script type="module" crossorigin src="/assets/index-B2MKmN57.js"></script>
49
- <link rel="stylesheet" crossorigin href="/assets/index-Btb13Da-.css">
50
- </head>
51
- <body>
52
- <noscript>You need to enable JavaScript to run this app.</noscript>
53
- <div id="app"></div>
54
- </body>
55
- </html>
package/dist/llms.txt DELETED
@@ -1,561 +0,0 @@
1
- # introduction.mdx
2
- ## Introduction
3
-
4
- Welcome to Docucod and Dory documentation
5
-
6
- # Introduction
7
-
8
- ## Welcome to Docucod and Dory
9
-
10
- This documentation is powered by two complementary tools:
11
-
12
- 1. **Docucod** - An AI-powered documentation assistant that automatically generates and maintains documentation
13
- 2. **Dory** - A lightweight static site generator specifically designed to deploy dory-generated documentation
14
-
15
- ## What is Docucod?
16
-
17
- Docucod analyzes your codebase and automatically:
18
- - Generates comprehensive documentation
19
- - Updates existing documentation when code changes
20
- - Maintains consistent style and formatting
21
- - Ensures accuracy and completeness
22
-
23
- ## What is Dory?
24
-
25
- Dory is a lightweight static site generator built for developers who want fast, clean, and customizable documentation. It was created specifically to deploy dory-generated documentation with:
26
-
27
- - 🧠 **Simple** — Drop in `.mdx` files and configure one `dory.json`
28
- - ⚡ **Fast** — Instant hot reload in dev, quick static builds for prod
29
- - 🌐 **Portable** — No SSR, no lock-in, deploy anywhere
30
- - 🧩 **Flexible** — Hackable theme, readable codebase, minimal magic
31
-
32
- ## Documentation Structure
33
-
34
- This documentation is organized to help you:
35
- - Get started quickly with both Docucod and Dory
36
- - Understand core concepts and features
37
- - Follow best practices and examples
38
- - Find detailed API references
39
-
40
- Let's begin exploring Docucod and Dory's capabilities!
41
-
42
- ---
43
-
44
-
45
- # features.mdx
46
- ## Features
47
-
48
- Overview of available components and features
49
-
50
- ## Headings Examples
51
-
52
- ```
53
- # Heading 1
54
- ```
55
- # Heading 1
56
-
57
- ```
58
- ## Heading 2
59
- ```
60
- # Heading 2
61
-
62
- ```
63
- ### Heading 3
64
- ```
65
- # Heading 3
66
- ```
67
- #### Heading 4
68
- ```
69
- # Heading 4
70
- ```
71
- ##### Heading 5
72
- ```
73
- # Heading 5
74
- ```
75
- ###### Heading 6
76
- ```
77
- # Heading 6
78
-
79
- ## Lists Examples
80
-
81
- ```
82
- - List item 1
83
- - List item 2
84
- - List item 3
85
- ```
86
-
87
- - List item 1
88
- - List item 2
89
- - List item 3
90
-
91
- ```
92
- 1. List item 1
93
- 2. List item 2
94
- 3. List item 3
95
- ```
96
-
97
- 1. List item 1
98
- 2. List item 2
99
- 3. List item 3
100
-
101
- ### Images
102
-
103
- ```
104
-
105
- ```
106
-
107
- ## Code Components
108
-
109
- ### Code Block
110
- ```
111
- function example() {
112
- return "Hello World";
113
- }
114
- ```
115
-
116
- ### Code Group Block
117
-
118
- ```
119
- function example(): string {
120
- return "Hello World";
121
- }
122
- ```
123
- ```
124
- function example() {
125
- return "Hello World";
126
- }
127
- ```
128
-
129
- ## Interactive Components
130
-
131
- ### Mermaid
132
-
133
- ```
134
- mermaid
135
- graph TD
136
-
137
- %% Main Start
138
- Start([Start Process]) --> Validate[Validate Input]
139
-
140
- %% Decision Point
141
- Validate -->|Valid| ProcessData{Is Data Clean?}
142
- Validate -->|Invalid| Error[Show Error Message]
143
-
144
- %% Clean Data Branch
145
- ProcessData -->|Yes| Clean[Clean Data]
146
- Clean --> Analyze[Analyze Data]
147
-
148
- %% Dirty Data Branch
149
- ProcessData -->|No| Notify[Notify User]
150
- Notify --> Wait[Wait for Input]
151
- Wait --> Validate
152
-
153
- %% Parallel Branches After Analysis
154
- Analyze --> Split1 & Split2
155
-
156
- subgraph Parallel Tasks
157
- Split1[Generate Report] --> Merge
158
- Split2[Update Dashboard] --> Merge
159
- end
160
-
161
- Merge --> Decision2{Is More Input Needed?}
162
- Decision2 -->|Yes| WaitMore[Wait for More Input]
163
- WaitMore --> Validate
164
- Decision2 -->|No| End([End Process])
165
-
166
- %% Style and Class Definitions
167
- classDef decision fill:#f9f,stroke:#333,stroke-width:2px;
168
- class ProcessData,Decision2 decision;
169
-
170
- ```
171
-
172
- Note: Mermaid should be inside a code block with type "mermaid"
173
-
174
- ```
175
- graph TD
176
-
177
- %% Main Start
178
- Start([Start Process]) --> Validate[Validate Input]
179
-
180
- %% Decision Point
181
- Validate -->|Valid| ProcessData{Is Data Clean?}
182
- Validate -->|Invalid| Error[Show Error Message]
183
-
184
- %% Clean Data Branch
185
- ProcessData -->|Yes| Clean[Clean Data]
186
- Clean --> Analyze[Analyze Data]
187
-
188
- %% Dirty Data Branch
189
- ProcessData -->|No| Notify[Notify User]
190
- Notify --> Wait[Wait for Input]
191
- Wait --> Validate
192
-
193
- %% Parallel Branches After Analysis
194
- Analyze --> Split1 & Split2
195
-
196
- subgraph Parallel Tasks
197
- Split1[Generate Report] --> Merge
198
- Split2[Update Dashboard] --> Merge
199
- end
200
-
201
- Merge --> Decision2{Is More Input Needed?}
202
- Decision2 -->|Yes| WaitMore[Wait for More Input]
203
- WaitMore --> Validate
204
- Decision2 -->|No| End([End Process])
205
-
206
- %% Style and Class Definitions
207
- classDef decision fill:#f9f,stroke:#333,stroke-width:2px;
208
- class ProcessData,Decision2 decision;
209
-
210
- ```
211
-
212
- ### Accordion
213
-
214
- ```
215
-
216
- This is the content of the first accordion section.
217
-
218
- This is the content of the second accordion section.
219
-
220
- ```
221
-
222
- This is the content of the first accordion section.
223
-
224
- This is the content of the second accordion section.
225
-
226
- ### Callouts
227
-
228
- ```
229
-
230
- This is a note callout with important information.
231
-
232
- ```
233
-
234
- This is a note callout with important information.
235
-
236
- ```
237
-
238
- This is a warning callout for critical information.
239
-
240
- ```
241
-
242
- This is a warning callout for critical information.
243
-
244
- ```
245
-
246
- This is an info callout for general information.
247
-
248
- ```
249
-
250
- This is an info callout for general information.
251
-
252
- ```
253
-
254
- This is a tip callout for helpful suggestions.
255
-
256
- ```
257
-
258
- This is a tip callout for helpful suggestions.
259
-
260
- ```
261
-
262
- This is a check callout for completed items.
263
-
264
- ```
265
-
266
- This is a check callout for completed items.
267
-
268
- ### Cards
269
- ```
270
-
271
- ```
272
-
273
- ### Expandable
274
-
275
- ```
276
-
277
- This is an expandable section that can be toggled.
278
-
279
- ```
280
-
281
- This is an expandable section that can be toggled.
282
-
283
- ### Source
284
-
285
- ```
286
-
287
- ```
288
-
289
- ## Special Components
290
-
291
- ### Grids
292
-
293
- #### Rows
294
- ```
295
-
296
- ```
297
-
298
- #### Columns
299
-
300
- ```
301
-
302
- ```
303
-
304
- ### Latex
305
-
306
- ```
307
-
308
- E = mc^2
309
-
310
- ```
311
-
312
- E = mc^2
313
-
314
- ### Tables
315
-
316
- ```
317
- | Property | Description |
318
- | -------- | ------------------------------------- |
319
- | Name | Full name of user |
320
- | Age | Reported age |
321
- | Joined | Whether the user joined the community |
322
- ```
323
-
324
- | Property | Description |
325
- | -------- | ------------------------------------- |
326
- | Name | Full name of user |
327
- | Age | Reported age |
328
- | Joined | Whether the user joined the community |
329
-
330
- ### Steps
331
-
332
- ```
333
-
334
- This is the first step in the process.
335
-
336
- This is the second step in the process.
337
-
338
- ```
339
-
340
- This is the first step in the process.
341
-
342
- This is the second step in the process.
343
-
344
- ### Icons
345
-
346
- ```
347
-
348
- ```
349
-
350
- ---
351
-
352
-
353
- # websocket-playground-demo.mdx
354
- ## WebSocket Playground Demo
355
-
356
- Interactive WebSocket playground for testing real-time connections
357
-
358
- # WebSocket Playground Demo
359
-
360
- This page demonstrates the WebSocket playground component with various configuration options and real-time connection testing capabilities.
361
-
362
- ## Basic WebSocket Connection
363
-
364
- ## WebSocket with Subprotocols
365
-
366
- ## WebSocket with Authentication
367
-
368
- ## Real-time Chat Example
369
-
370
- ## Testing Instructions
371
-
372
- 1. **Connect**: Click the "Connect" button to establish a WebSocket connection
373
- 2. **Send Messages**: Type messages in the input field and click "Send" or press Enter
374
- 3. **View Messages**: All sent and received messages appear in the message history with timestamps
375
- 4. **Configuration**: Use the tabs to configure headers, subprotocols, and authentication
376
- 5. **Server Selection**: Choose different servers from the dropdown to test various endpoints
377
-
378
- ## Features
379
-
380
- - **Real-time Connection**: Live WebSocket connection with status indicators
381
- - **Message History**: View all sent/received messages with timestamps
382
- - **Custom Headers**: Add authentication and custom headers
383
- - **Subprotocols**: Configure WebSocket subprotocols
384
- - **Multiple Servers**: Easy switching between different WebSocket endpoints
385
- - **Error Handling**: Clear error messages for connection issues
386
- - **Binary Support**: Handles both text and binary messages
387
-
388
- ## Message Types
389
-
390
- The playground supports different message types:
391
- - **Sent**: Messages you send (blue background)
392
- - **Received**: Messages from the server (green background)
393
- - **Error**: Connection or sending errors (red background)
394
- - **System**: Connection status updates (gray background)
395
-
396
- ## Example Messages
397
-
398
- Try sending these JSON messages to test structured data:
399
-
400
- ```
401
- {
402
- "type": "chat",
403
- "message": "Hello, WebSocket!",
404
- "userId": "user123",
405
- "timestamp": "2024-01-15T10:30:00Z"
406
- }
407
- ```
408
-
409
- ```
410
- {
411
- "type": "presence",
412
- "status": "online",
413
- "userId": "user123"
414
- }
415
- ```
416
-
417
- ```
418
- {
419
- "type": "notification",
420
- "title": "Test Notification",
421
- "message": "This is a test notification",
422
- "level": "info"
423
- }
424
- ```
425
-
426
- ---
427
-
428
-
429
- # api-reference/operations/create.mdx
430
- ## POST /products
431
-
432
- Create a new product
433
-
434
-
435
-
436
- ---
437
-
438
-
439
- # api-reference/operations/get.mdx
440
- ---
441
- title: 'GET /products'
442
- description: 'Get a list of products'
443
- openapi: 'GET /products'
444
- ---
445
-
446
- ---
447
-
448
-
449
- # api-reference/operations/update.mdx
450
- ---
451
- title: 'PUT /products/{id}'
452
- description: 'Update a product'
453
- openapi: 'PUT /products/{id}'
454
- ---
455
-
456
- ---
457
-
458
-
459
- # api-reference/operations/delete.mdx
460
- ---
461
- title: 'DELETE /products/{id}'
462
- description: 'Delete a product'
463
- openapi: 'DELETE /products/{id}'
464
- ---
465
-
466
- ---
467
-
468
-
469
- # api-reference/websocket-operations/send-chat-message.mdx
470
- ---
471
- title: 'PUBLISH /chat'
472
- description: 'Send a chat message to other users'
473
- asyncapi: 'publish /chat'
474
- ---
475
-
476
- ---
477
-
478
-
479
- # api-reference/websocket-operations/receive-chat-message.mdx
480
- ---
481
- title: 'SUBSCRIBE /chat'
482
- description: 'Subscribe to receive chat messages from other users'
483
- asyncapi: 'subscribe /chat'
484
- ---
485
-
486
- ---
487
-
488
-
489
- # api-reference/websocket-operations/receive-notifications.mdx
490
- ---
491
- title: 'SUBSCRIBE /notifications'
492
- description: 'Subscribe to receive system notifications'
493
- asyncapi: 'subscribe /notifications'
494
- ---
495
-
496
- ---
497
-
498
-
499
- # api-reference/websocket-operations/send-presence-update.mdx
500
- ---
501
- title: 'PUBLISH /presence'
502
- description: 'Send a presence update'
503
- asyncapi: 'publish /presence'
504
- ---
505
-
506
- ---
507
-
508
-
509
- # api-reference/websocket-operations/receive-presence-update.mdx
510
- ---
511
- title: 'SUBSCRIBE /presence'
512
- description: 'Subscribe to receive user presence updates'
513
- asyncapi: 'subscribe /presence'
514
- ---
515
-
516
- ---
517
-
518
-
519
- # api-playground-demo.mdx
520
- ## API Playground Demo
521
-
522
- Interactive API playground for testing HTTP endpoints
523
-
524
- # API Playground Demo
525
-
526
- This page demonstrates the new HTTP API playground that allows you to test API endpoints directly from the documentation.
527
-
528
- ## Basic GET Request
529
-
530
- Test a simple GET request with query parameters:
531
-
532
- ## POST Request with Body
533
-
534
- Test a POST request with a JSON body:
535
-
536
- ## Authenticated Endpoint
537
-
538
- Test an endpoint that requires authentication:
539
-
540
- ## Features
541
-
542
- The API playground provides:
543
-
544
- - **Interactive Request Configuration**: Set parameters, headers, request body, and authentication
545
- - **Multiple Auth Types**: Support for Bearer token, API key, and Basic authentication
546
- - **Real-time Response**: See actual HTTP responses with status codes, headers, and formatted JSON
547
- - **Request Timing**: Monitor request duration for performance analysis
548
- - **Error Handling**: Clear error messages for failed requests
549
- - **Copy-Paste Ready**: Generate curl commands and code examples
550
-
551
- ## Usage in Documentation
552
-
553
- To add a playground to your API documentation, use the `APIPlayground` component:
554
-
555
- ```
556
-
557
- ```
558
-
559
- The playground seamlessly integrates with your existing API documentation and provides a Postman-like experience directly in the docs.
560
-
561
- ---
package/dist/logo/logo.svg DELETED
@@ -1,18 +0,0 @@
1
- <svg width="22" height="24" viewBox="0 0 22 24" fill="none" xmlns="http://www.w3.org/2000/svg">
2
- <path d="M21.9941 4.99951C19.9947 3.00079 19.9947 3.00079 16.9956 0.00271368V4.99951H21.9941Z" fill="#92BFFA"/>
3
- <path d="M7.49782 3.91843C7.49782 4.5155 7.98183 4.99951 8.5789 4.99951H16.9951V0.00271606H8.5789C7.98183 0.00271606 7.49782 0.486733 7.49782 1.0838V3.91843Z" fill="url(#paint0_linear_66_680)"/>
4
- <path d="M21.9932 5.01123C22.0049 8.20987 21.9983 17.7036 21.9951 21.9995C21.9943 23.1041 21.0977 23.9995 19.9932 23.9995H2C0.895431 23.9995 3.87055e-07 23.1041 0 21.9995V8.59131C0 7.99426 0.48401 7.51028 1.08105 7.51025H3.91797C4.51481 7.51052 4.99902 7.99441 4.99902 8.59131V19.5024H16.9951V5.01123H21.9932Z" fill="url(#paint1_linear_66_680)"/>
5
- <ellipse cx="12.3217" cy="14.276" rx="1.2973" ry="1.29647" fill="#1967D2"/>
6
- <path d="M5 0.00634813C5.55157 0.00730227 5.99805 0.454718 5.99805 1.00635V4.01221C5.99805 4.64068 6.29707 5.23179 6.80273 5.60498L7.46777 6.09619C7.81171 6.35003 8.22878 6.48682 8.65625 6.48682H14.4951C15.0472 6.48682 15.4949 6.93475 15.4951 7.48682V16.98C15.4951 17.5322 15.0474 17.98 14.4951 17.98H7.49805C6.94583 17.9799 6.49808 17.5322 6.49805 16.98V8.67139C6.49806 8.23724 6.35689 7.81407 6.0957 7.46729L5.58691 6.79248C5.21558 6.29954 4.63759 6.00515 4.02051 5.99561H1C0.447722 5.9956 0 5.54789 0 4.99561V1.00049C0.000165845 0.447951 0.448441 -4.60729e-05 1.00098 0.00048876L5 0.00634813Z" fill="#FFC236"/>
7
- <ellipse cx="12.9961" cy="15.505" rx="1" ry="0.999359" fill="#3630C4"/>
8
- <defs>
9
- <linearGradient id="paint0_linear_66_680" x1="10.9999" y1="0.00271606" x2="10.9999" y2="23.9995" gradientUnits="userSpaceOnUse">
10
- <stop stop-color="#528FF4"/>
11
- <stop offset="1" stop-color="#92BFFA"/>
12
- </linearGradient>
13
- <linearGradient id="paint1_linear_66_680" x1="10.9999" y1="0.00271606" x2="10.9999" y2="23.9995" gradientUnits="userSpaceOnUse">
14
- <stop stop-color="#528FF4"/>
15
- <stop offset="1" stop-color="#92BFFA"/>
16
- </linearGradient>
17
- </defs>
18
- </svg>