@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/docs/features.mdx DELETED
@@ -1,440 +0,0 @@
1
- ---
2
- title: 'Features'
3
- description: 'Overview of available components and features'
4
- ---
5
-
6
- ## Headings Examples
7
-
8
- ```mdx
9
- # Heading 1
10
- ```
11
- # Heading 1
12
-
13
- ```mdx
14
- ## Heading 2
15
- ```
16
- # Heading 2
17
-
18
- ```mdx
19
- ### Heading 3
20
- ```
21
- # Heading 3
22
- ```mdx
23
- #### Heading 4
24
- ```
25
- # Heading 4
26
- ```mdx
27
- ##### Heading 5
28
- ```
29
- # Heading 5
30
- ```mdx
31
- ###### Heading 6
32
- ```
33
- # Heading 6
34
-
35
- <br />
36
-
37
- ## Lists Examples
38
-
39
- ```mdx
40
- - List item 1
41
- - List item 2
42
- - List item 3
43
- ```
44
-
45
- - List item 1
46
- - List item 2
47
- - List item 3
48
-
49
- ```mdx
50
- 1. List item 1
51
- 2. List item 2
52
- 3. List item 3
53
- ```
54
-
55
- 1. List item 1
56
- 2. List item 2
57
- 3. List item 3
58
-
59
-
60
-
61
- <br />
62
-
63
- ### Images
64
-
65
- ```mdx
66
- <img src="./assets/dory.jpeg" alt="Example image" className="object-cover w-64 h-64" />
67
- ```
68
-
69
- <img src="./assets/dory.jpeg" alt="Example image" className="object-cover w-64 h-64" />
70
-
71
-
72
- <br />
73
- <br />
74
- <br />
75
-
76
- ## Code Components
77
-
78
- ### Code Block
79
- ```typescript
80
- function example() {
81
- return "Hello World";
82
- }
83
- ```
84
-
85
- ### Code Group Block
86
-
87
- <CodeGroup>
88
- ```typescript
89
- function example(): string {
90
- return "Hello World";
91
- }
92
- ```
93
- ```javascript
94
- function example() {
95
- return "Hello World";
96
- }
97
- ```
98
- </CodeGroup>
99
-
100
-
101
- <br />
102
- <br />
103
- <br />
104
-
105
-
106
- ## Interactive Components
107
-
108
- ### Mermaid
109
-
110
- ```mdx
111
- mermaid
112
- graph TD
113
-
114
- %% Main Start
115
- Start([Start Process]) --> Validate[Validate Input]
116
-
117
- %% Decision Point
118
- Validate -->|Valid| ProcessData{Is Data Clean?}
119
- Validate -->|Invalid| Error[Show Error Message]
120
-
121
- %% Clean Data Branch
122
- ProcessData -->|Yes| Clean[Clean Data]
123
- Clean --> Analyze[Analyze Data]
124
-
125
- %% Dirty Data Branch
126
- ProcessData -->|No| Notify[Notify User]
127
- Notify --> Wait[Wait for Input]
128
- Wait --> Validate
129
-
130
- %% Parallel Branches After Analysis
131
- Analyze --> Split1 & Split2
132
-
133
- subgraph Parallel Tasks
134
- Split1[Generate Report] --> Merge
135
- Split2[Update Dashboard] --> Merge
136
- end
137
-
138
- Merge --> Decision2{Is More Input Needed?}
139
- Decision2 -->|Yes| WaitMore[Wait for More Input]
140
- WaitMore --> Validate
141
- Decision2 -->|No| End([End Process])
142
-
143
- %% Style and Class Definitions
144
- classDef decision fill:#f9f,stroke:#333,stroke-width:2px;
145
- class ProcessData,Decision2 decision;
146
-
147
- ```
148
-
149
- <strong>
150
- <p>Note: Mermaid should be inside a code block with type "mermaid"</p>
151
- </strong>
152
-
153
- ```mermaid
154
- graph TD
155
-
156
- %% Main Start
157
- Start([Start Process]) --> Validate[Validate Input]
158
-
159
- %% Decision Point
160
- Validate -->|Valid| ProcessData{Is Data Clean?}
161
- Validate -->|Invalid| Error[Show Error Message]
162
-
163
- %% Clean Data Branch
164
- ProcessData -->|Yes| Clean[Clean Data]
165
- Clean --> Analyze[Analyze Data]
166
-
167
- %% Dirty Data Branch
168
- ProcessData -->|No| Notify[Notify User]
169
- Notify --> Wait[Wait for Input]
170
- Wait --> Validate
171
-
172
- %% Parallel Branches After Analysis
173
- Analyze --> Split1 & Split2
174
-
175
- subgraph Parallel Tasks
176
- Split1[Generate Report] --> Merge
177
- Split2[Update Dashboard] --> Merge
178
- end
179
-
180
- Merge --> Decision2{Is More Input Needed?}
181
- Decision2 -->|Yes| WaitMore[Wait for More Input]
182
- WaitMore --> Validate
183
- Decision2 -->|No| End([End Process])
184
-
185
- %% Style and Class Definitions
186
- classDef decision fill:#f9f,stroke:#333,stroke-width:2px;
187
- class ProcessData,Decision2 decision;
188
-
189
- ```
190
-
191
- ### Accordion
192
-
193
- ```mdx
194
- <AccordionGroup>
195
- <Accordion title="First Section" icon="DocumentIcon">
196
- This is the content of the first accordion section.
197
- </Accordion>
198
- <Accordion title="Second Section" icon="CodeBracketIcon">
199
- This is the content of the second accordion section.
200
- </Accordion>
201
- </AccordionGroup>
202
- ```
203
-
204
- <AccordionGroup>
205
- <Accordion title="First Section" icon="DocumentIcon">
206
- This is the content of the first accordion section.
207
- </Accordion>
208
- <Accordion title="Second Section" icon="CodeBracketIcon">
209
- This is the content of the second accordion section.
210
- </Accordion>
211
- </AccordionGroup>
212
-
213
- ### Callouts
214
-
215
- ```mdx
216
- <Note>
217
- This is a note callout with important information.
218
- </Note>
219
- ```
220
-
221
- <Note>
222
- This is a note callout with important information.
223
- </Note>
224
-
225
- ```mdx
226
- <Warning>
227
- This is a warning callout for critical information.
228
- </Warning>
229
- ```
230
-
231
- <Warning>
232
- This is a warning callout for critical information.
233
- </Warning>
234
-
235
- ```mdx
236
- <Info>
237
- This is an info callout for general information.
238
- </Info>
239
- ```
240
-
241
- <Info>
242
- This is an info callout for general information.
243
- </Info>
244
-
245
- ```mdx
246
- <Tip>
247
- This is a tip callout for helpful suggestions.
248
- </Tip>
249
- ```
250
-
251
- <Tip>
252
- This is a tip callout for helpful suggestions.
253
- </Tip>
254
-
255
- ```mdx
256
- <Check>
257
- This is a check callout for completed items.
258
- </Check>
259
- ```
260
-
261
- <Check>
262
- This is a check callout for completed items.
263
- </Check>
264
-
265
-
266
- <br />
267
-
268
- ### Cards
269
- ```mdx
270
- <CardGroup cols={2}>
271
- <Card
272
- title="Example Card"
273
- description="This is an example card component with an icon and title."
274
- icon="FileText"
275
- href="#"
276
- />
277
- <Card
278
- title="Another Card"
279
- description="This is another example card with different content."
280
- icon="Code"
281
- href="#"
282
- />
283
- </CardGroup>
284
- ```
285
-
286
- <CardGroup cols={2}>
287
- <Card
288
- title="Example Card"
289
- description="This is an example card component with an icon and title."
290
- icon="FileText"
291
- href="#"
292
- />
293
- <Card
294
- title="Another Card"
295
- description="This is another example card with different content."
296
- icon="Code"
297
- href="#"
298
- />
299
- </CardGroup>
300
-
301
- <br />
302
-
303
- ### Expandable
304
-
305
- ```mdx
306
- <Expandable title="Click to Expand">
307
- This is an expandable section that can be toggled.
308
- </Expandable>
309
- ```
310
-
311
- <Expandable title="Click to Expand">
312
- This is an expandable section that can be toggled.
313
- </Expandable>
314
-
315
- ### Source
316
-
317
- ```mdx
318
- <Source url="https://github.com/clidey/dory" paths={[
319
- { path: "src/mdx/source.tsx", range: "1-46" },
320
- { path: "docs/features.mdx", range: "318-322" },
321
- ]} />
322
- ```
323
-
324
- <Source url="https://github.com/clidey/dory" paths={[
325
- { path: "src/mdx/source.tsx", range: "1-46" },
326
- { path: "docs/features.mdx", range: "318-322" },
327
- ]} />
328
-
329
- <br />
330
- <br />
331
- <br />
332
-
333
-
334
- ## Special Components
335
-
336
- ### Grids
337
-
338
- #### Rows
339
- ```mdx
340
- <Row cols={2}>
341
- <Icon icon="FileText" />
342
- <Icon icon="CheckCircle" />
343
- </Row>
344
- ```
345
-
346
- <Row cols={2}>
347
- <Icon icon="FileText" />
348
- <Icon icon="CheckCircle" />
349
- </Row>
350
-
351
- <br />
352
-
353
- #### Columns
354
-
355
- ```mdx
356
- <Col>
357
- <Icon icon="FileText" />
358
- <Icon icon="FileText" />
359
- </Col>
360
- ```
361
-
362
- <Col>
363
- <Icon icon="FileText" />
364
- <Icon icon="FileText" />
365
- </Col>
366
-
367
- <br />
368
- <br />
369
- <br />
370
-
371
- ### Latex
372
-
373
- ```mdx
374
- <Latex>
375
- E = mc^2
376
- </Latex>
377
- ```
378
-
379
- <Latex>
380
- E = mc^2
381
- </Latex>
382
-
383
- <br />
384
- <br />
385
- <br />
386
-
387
- ### Tables
388
-
389
- ```mdx
390
- | Property | Description |
391
- | -------- | ------------------------------------- |
392
- | Name | Full name of user |
393
- | Age | Reported age |
394
- | Joined | Whether the user joined the community |
395
- ```
396
-
397
- | Property | Description |
398
- | -------- | ------------------------------------- |
399
- | Name | Full name of user |
400
- | Age | Reported age |
401
- | Joined | Whether the user joined the community |
402
-
403
-
404
- ### Steps
405
-
406
- ```mdx
407
- <Steps>
408
- <Step title="First Step">
409
- This is the first step in the process.
410
- </Step>
411
- <Step title="Second Step">
412
- This is the second step in the process.
413
- </Step>
414
- </Steps>
415
- ```
416
-
417
- <Steps>
418
- <Step title="First Step">
419
- This is the first step in the process.
420
- </Step>
421
- <Step title="Second Step">
422
- This is the second step in the process.
423
- </Step>
424
- </Steps>
425
-
426
- ### Icons
427
-
428
- ```mdx
429
- <Col rows={2}>
430
- <Icon icon="Code" />
431
- <Icon icon="FileText" />
432
- <Icon icon="CheckCircle" />
433
- </Col>
434
- ```
435
-
436
- <Row cols={3}>
437
- <Icon icon="Code" />
438
- <Icon icon="FileText" />
439
- <Icon icon="CheckCircle" />
440
- </Row>
@@ -1,44 +0,0 @@
1
- ---
2
- title: 'Introduction'
3
- description: 'Welcome to Docucod and Dory documentation'
4
- ---
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
- <br/>
43
- <br/>
44
- <br/>
@@ -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>
@@ -1,135 +0,0 @@
1
- ---
2
- title: 'WebSocket Playground Demo'
3
- description: 'Interactive WebSocket playground for testing real-time connections'
4
- ---
5
-
6
- # WebSocket Playground Demo
7
-
8
- This page demonstrates the WebSocket playground component with various configuration options and real-time connection testing capabilities.
9
-
10
- ## Basic WebSocket Connection
11
-
12
- <WebSocketPlayground
13
- url="/ws/chat"
14
- title="Basic Chat WebSocket"
15
- description="Connect to a WebSocket server and send/receive messages in real-time"
16
- servers={[
17
- {
18
- url: "wss://echo.websocket.org",
19
- description: "WebSocket Echo Server"
20
- },
21
- {
22
- url: "wss://ws.postman-echo.com/raw",
23
- description: "Postman Echo WebSocket"
24
- }
25
- ]}
26
- />
27
-
28
- ## WebSocket with Subprotocols
29
-
30
- <WebSocketPlayground
31
- url="/ws/protocol"
32
- title="WebSocket with Subprotocols"
33
- description="WebSocket connection with custom subprotocols for specialized communication"
34
- subprotocols={["chat", "v1.0"]}
35
- servers={[
36
- {
37
- url: "wss://echo.websocket.org",
38
- description: "Echo Server with Subprotocols"
39
- }
40
- ]}
41
- />
42
-
43
- ## WebSocket with Authentication
44
-
45
- <WebSocketPlayground
46
- url="/ws/secure"
47
- title="Authenticated WebSocket"
48
- description="WebSocket connection with authentication headers"
49
- authType="bearer"
50
- headers={{
51
- "User-Agent": "Dory WebSocket Client",
52
- "X-Client-Version": "1.0.0"
53
- }}
54
- servers={[
55
- {
56
- url: "wss://echo.websocket.org",
57
- description: "Secure Echo Server"
58
- }
59
- ]}
60
- />
61
-
62
- ## Real-time Chat Example
63
-
64
- <WebSocketPlayground
65
- url="/chat"
66
- title="Real-time Chat"
67
- description="Connect to a chat server and participate in real-time conversations"
68
- subprotocols={["chat.v1", "json"]}
69
- headers={{
70
- "X-Client-Type": "web",
71
- "X-Protocol-Version": "1.0"
72
- }}
73
- servers={[
74
- {
75
- url: "wss://echo.websocket.org",
76
- description: "Chat Echo Server"
77
- }
78
- ]}
79
- />
80
-
81
- ## Testing Instructions
82
-
83
- 1. **Connect**: Click the "Connect" button to establish a WebSocket connection
84
- 2. **Send Messages**: Type messages in the input field and click "Send" or press Enter
85
- 3. **View Messages**: All sent and received messages appear in the message history with timestamps
86
- 4. **Configuration**: Use the tabs to configure headers, subprotocols, and authentication
87
- 5. **Server Selection**: Choose different servers from the dropdown to test various endpoints
88
-
89
- ## Features
90
-
91
- - **Real-time Connection**: Live WebSocket connection with status indicators
92
- - **Message History**: View all sent/received messages with timestamps
93
- - **Custom Headers**: Add authentication and custom headers
94
- - **Subprotocols**: Configure WebSocket subprotocols
95
- - **Multiple Servers**: Easy switching between different WebSocket endpoints
96
- - **Error Handling**: Clear error messages for connection issues
97
- - **Binary Support**: Handles both text and binary messages
98
-
99
- ## Message Types
100
-
101
- The playground supports different message types:
102
- - **Sent**: Messages you send (blue background)
103
- - **Received**: Messages from the server (green background)
104
- - **Error**: Connection or sending errors (red background)
105
- - **System**: Connection status updates (gray background)
106
-
107
- ## Example Messages
108
-
109
- Try sending these JSON messages to test structured data:
110
-
111
- ```json
112
- {
113
- "type": "chat",
114
- "message": "Hello, WebSocket!",
115
- "userId": "user123",
116
- "timestamp": "2024-01-15T10:30:00Z"
117
- }
118
- ```
119
-
120
- ```json
121
- {
122
- "type": "presence",
123
- "status": "online",
124
- "userId": "user123"
125
- }
126
- ```
127
-
128
- ```json
129
- {
130
- "type": "notification",
131
- "title": "Test Notification",
132
- "message": "This is a test notification",
133
- "level": "info"
134
- }
135
- ```
package/index.html DELETED
@@ -1,54 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8" />
5
- <link rel="icon" href="./docs/favicon.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 generates and maintains up-to-date documentation from your codebase so your team can move fast, onboard quickly, and stay focused on building." />
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: Generate and Maintain Documentation With No Work" />
17
- <meta property="og:description" content="Docucod auto-generates and maintains up-to-date documentation from your codebase so your team can move fast, onboard quickly, and stay focused on building." />
18
- <meta property="og:image" content="./docs/favicon.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: Generate and Maintain Documentation With No Work" />
27
- <meta name="twitter:description" content="Docucod auto-generates and maintains up-to-date documentation from your codebase so your team can move fast, onboard quickly, and stay focused on building." />
28
- <meta name="twitter:image" content="./docs/favicon.svg" />
29
- <meta name="twitter:site" content="@ClideyOfficial" />
30
- <meta name="twitter:creator" content="@ClideyOfficial" />
31
-
32
- <link rel="apple-touch-icon" href="./docs/favicon.svg" />
33
- <link rel="manifest" href="/manifest.json" />
34
-
35
- <title>Docucod - Instantly Generate and Maintain Your Documentation</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
- </head>
49
- <body>
50
- <noscript>You need to enable JavaScript to run this app.</noscript>
51
- <div id="app"></div>
52
- <script type="module" src="/src/main.tsx"></script>
53
- </body>
54
- </html>