@clidey/dory 0.21.2 → 0.22.0

package/dist/llms.txt

@@ -0,0 +1,561 @@
+# introduction.mdx
+## Introduction
+
+Welcome to Docucod and Dory documentation
+
+# Introduction
+
+## Welcome to Docucod and Dory
+
+This documentation is powered by two complementary tools:
+
+1. **Docucod** - An AI-powered documentation assistant that automatically generates and maintains documentation
+2. **Dory** - A lightweight static site generator specifically designed to deploy Docucod-generated documentation
+
+## What is Docucod?
+
+Docucod analyzes your codebase and automatically:
+- Generates comprehensive documentation
+- Updates existing documentation when code changes
+- Maintains consistent style and formatting
+- Ensures accuracy and completeness
+
+## What is Dory?
+
+Dory is a lightweight static site generator built for developers who want fast, clean, and customizable documentation. It was created specifically to deploy Docucod-generated documentation with:
+
+- 🧠 **Simple** — Drop in `.mdx` files and configure one `dory.json`
+- ⚡ **Fast** — Instant hot reload in dev, quick static builds for prod
+- 🌐 **Portable** — No SSR, no lock-in, deploy anywhere
+- 🧩 **Flexible** — Hackable theme, readable codebase, minimal magic
+
+## Documentation Structure
+
+This documentation is organized to help you:
+- Get started quickly with both Docucod and Dory
+- Understand core concepts and features
+- Follow best practices and examples
+- Find detailed API references
+
+Let's begin exploring Docucod and Dory's capabilities!
+
+---
+
+
+# features.mdx
+## Features
+
+Overview of available components and features
+
+## Headings Examples
+
+```
+# Heading 1
+```
+# Heading 1
+
+```
+## Heading 2
+```
+# Heading 2
+
+```
+### Heading 3
+```
+# Heading 3
+```
+#### Heading 4
+```
+# Heading 4
+```
+##### Heading 5
+```
+# Heading 5
+```
+###### Heading 6
+```
+# Heading 6
+
+## Lists Examples
+
+```
+- List item 1
+- List item 2
+- List item 3
+```
+
+- List item 1
+- List item 2
+- List item 3
+
+```
+1. List item 1
+2. List item 2
+3. List item 3
+```
+
+1. List item 1
+2. List item 2
+3. List item 3
+
+### Images
+
+```
+
+```
+
+## Code Components
+
+### Code Block
+```
+function example() {
+  return "Hello World";
+}
+```
+
+### Code Group Block
+
+```
+function example(): string {
+  return "Hello World";
+}
+```
+```
+function example() {
+  return "Hello World";
+}
+```
+
+## Interactive Components
+
+### Mermaid
+
+```
+mermaid
+graph TD
+
+  %% Main Start
+  Start([Start Process]) --> Validate[Validate Input]
+
+  %% Decision Point
+  Validate -->|Valid| ProcessData{Is Data Clean?}
+  Validate -->|Invalid| Error[Show Error Message]
+
+  %% Clean Data Branch
+  ProcessData -->|Yes| Clean[Clean Data]
+  Clean --> Analyze[Analyze Data]
+
+  %% Dirty Data Branch
+  ProcessData -->|No| Notify[Notify User]
+  Notify --> Wait[Wait for Input]
+  Wait --> Validate
+
+  %% Parallel Branches After Analysis
+  Analyze --> Split1 & Split2
+
+  subgraph Parallel Tasks
+    Split1[Generate Report] --> Merge
+    Split2[Update Dashboard] --> Merge
+  end
+
+  Merge --> Decision2{Is More Input Needed?}
+  Decision2 -->|Yes| WaitMore[Wait for More Input]
+  WaitMore --> Validate
+  Decision2 -->|No| End([End Process])
+
+  %% Style and Class Definitions
+  classDef decision fill:#f9f,stroke:#333,stroke-width:2px;
+  class ProcessData,Decision2 decision;
+
+```
+
+Note: Mermaid should be inside a code block with type "mermaid"
+
+```
+graph TD
+
+  %% Main Start
+  Start([Start Process]) --> Validate[Validate Input]
+
+  %% Decision Point
+  Validate -->|Valid| ProcessData{Is Data Clean?}
+  Validate -->|Invalid| Error[Show Error Message]
+
+  %% Clean Data Branch
+  ProcessData -->|Yes| Clean[Clean Data]
+  Clean --> Analyze[Analyze Data]
+
+  %% Dirty Data Branch
+  ProcessData -->|No| Notify[Notify User]
+  Notify --> Wait[Wait for Input]
+  Wait --> Validate
+
+  %% Parallel Branches After Analysis
+  Analyze --> Split1 & Split2
+
+  subgraph Parallel Tasks
+    Split1[Generate Report] --> Merge
+    Split2[Update Dashboard] --> Merge
+  end
+
+  Merge --> Decision2{Is More Input Needed?}
+  Decision2 -->|Yes| WaitMore[Wait for More Input]
+  WaitMore --> Validate
+  Decision2 -->|No| End([End Process])
+
+  %% Style and Class Definitions
+  classDef decision fill:#f9f,stroke:#333,stroke-width:2px;
+  class ProcessData,Decision2 decision;
+
+```
+
+### Accordion
+
+```
+
+    This is the content of the first accordion section.
+
+    This is the content of the second accordion section.
+
+```
+
+    This is the content of the first accordion section.
+
+    This is the content of the second accordion section.
+
+### Callouts
+
+```
+
+  This is a note callout with important information.
+
+```
+
+  This is a note callout with important information.
+
+```
+
+  This is a warning callout for critical information.
+
+```
+
+  This is a warning callout for critical information.
+
+```
+
+  This is an info callout for general information.
+
+```
+
+  This is an info callout for general information.
+
+```
+
+  This is a tip callout for helpful suggestions.
+
+```
+
+  This is a tip callout for helpful suggestions.
+
+```
+
+  This is a check callout for completed items.
+
+```
+
+  This is a check callout for completed items.
+
+### Cards
+```
+
+```
+
+### Expandable
+
+```
+
+  This is an expandable section that can be toggled.
+
+```
+
+  This is an expandable section that can be toggled.
+
+### Source
+
+```
+
+```
+
+## Special Components
+
+### Grids
+
+#### Rows
+```
+
+```
+
+#### Columns
+
+```
+
+```
+
+### Latex
+
+```
+
+E = mc^2
+
+```
+
+E = mc^2
+
+### Tables
+
+```
+| Property | Description                           |
+| -------- | ------------------------------------- |
+| Name     | Full name of user                     |
+| Age      | Reported age                          |
+| Joined   | Whether the user joined the community |
+```
+
+| Property | Description                           |
+| -------- | ------------------------------------- |
+| Name     | Full name of user                     |
+| Age      | Reported age                          |
+| Joined   | Whether the user joined the community |
+
+### Steps
+
+```
+
+  This is the first step in the process.
+
+  This is the second step in the process.
+
+```
+
+  This is the first step in the process.
+
+  This is the second step in the process.
+
+### Icons
+
+```
+
+```
+
+---
+
+
+# websocket-playground-demo.mdx
+## WebSocket Playground Demo
+
+Interactive WebSocket playground for testing real-time connections
+
+# WebSocket Playground Demo
+
+This page demonstrates the WebSocket playground component with various configuration options and real-time connection testing capabilities.
+
+## Basic WebSocket Connection
+
+## WebSocket with Subprotocols
+
+## WebSocket with Authentication
+
+## Real-time Chat Example
+
+## Testing Instructions
+
+1. **Connect**: Click the "Connect" button to establish a WebSocket connection
+2. **Send Messages**: Type messages in the input field and click "Send" or press Enter
+3. **View Messages**: All sent and received messages appear in the message history with timestamps
+4. **Configuration**: Use the tabs to configure headers, subprotocols, and authentication
+5. **Server Selection**: Choose different servers from the dropdown to test various endpoints
+
+## Features
+
+- **Real-time Connection**: Live WebSocket connection with status indicators
+- **Message History**: View all sent/received messages with timestamps
+- **Custom Headers**: Add authentication and custom headers
+- **Subprotocols**: Configure WebSocket subprotocols
+- **Multiple Servers**: Easy switching between different WebSocket endpoints
+- **Error Handling**: Clear error messages for connection issues
+- **Binary Support**: Handles both text and binary messages
+
+## Message Types
+
+The playground supports different message types:
+- **Sent**: Messages you send (blue background)
+- **Received**: Messages from the server (green background)
+- **Error**: Connection or sending errors (red background)
+- **System**: Connection status updates (gray background)
+
+## Example Messages
+
+Try sending these JSON messages to test structured data:
+
+```
+{
+  "type": "chat",
+  "message": "Hello, WebSocket!",
+  "userId": "user123",
+  "timestamp": "2024-01-15T10:30:00Z"
+}
+```
+
+```
+{
+  "type": "presence",
+  "status": "online",
+  "userId": "user123"
+}
+```
+
+```
+{
+  "type": "notification",
+  "title": "Test Notification",
+  "message": "This is a test notification",
+  "level": "info"
+}
+```
+
+---
+
+
+# api-reference/operations/create.mdx
+## POST /products
+
+Create a new product
+
+
+
+---
+
+
+# api-reference/operations/get.mdx
+---
+title: 'GET /products'
+description: 'Get a list of products'
+openapi: 'GET /products'
+---
+
+---
+
+
+# api-reference/operations/update.mdx
+---
+title: 'PUT /products/{id}'
+description: 'Update a product'
+openapi: 'PUT /products/{id}'
+---
+
+---
+
+
+# api-reference/operations/delete.mdx
+---
+title: 'DELETE /products/{id}'
+description: 'Delete a product'
+openapi: 'DELETE /products/{id}'
+---
+
+---
+
+
+# api-reference/websocket-operations/send-chat-message.mdx
+---
+title: 'PUBLISH /chat'
+description: 'Send a chat message to other users'
+asyncapi: 'publish /chat'
+---
+
+---
+
+
+# api-reference/websocket-operations/receive-chat-message.mdx
+---
+title: 'SUBSCRIBE /chat'
+description: 'Subscribe to receive chat messages from other users'
+asyncapi: 'subscribe /chat'
+---
+
+---
+
+
+# api-reference/websocket-operations/receive-notifications.mdx
+---
+title: 'SUBSCRIBE /notifications'
+description: 'Subscribe to receive system notifications'
+asyncapi: 'subscribe /notifications'
+---
+
+---
+
+
+# api-reference/websocket-operations/send-presence-update.mdx
+---
+title: 'PUBLISH /presence'
+description: 'Send a presence update'
+asyncapi: 'publish /presence'
+---
+
+---
+
+
+# api-reference/websocket-operations/receive-presence-update.mdx
+---
+title: 'SUBSCRIBE /presence'
+description: 'Subscribe to receive user presence updates'
+asyncapi: 'subscribe /presence'
+---
+
+---
+
+
+# api-playground-demo.mdx
+## API Playground Demo
+
+Interactive API playground for testing HTTP endpoints
+
+# API Playground Demo
+
+This page demonstrates the new HTTP API playground that allows you to test API endpoints directly from the documentation.
+
+## Basic GET Request
+
+Test a simple GET request with query parameters:
+
+## POST Request with Body
+
+Test a POST request with a JSON body:
+
+## Authenticated Endpoint
+
+Test an endpoint that requires authentication:
+
+## Features
+
+The API playground provides:
+
+- **Interactive Request Configuration**: Set parameters, headers, request body, and authentication
+- **Multiple Auth Types**: Support for Bearer token, API key, and Basic authentication
+- **Real-time Response**: See actual HTTP responses with status codes, headers, and formatted JSON
+- **Request Timing**: Monitor request duration for performance analysis
+- **Error Handling**: Clear error messages for failed requests
+- **Copy-Paste Ready**: Generate curl commands and code examples
+
+## Usage in Documentation
+
+To add a playground to your API documentation, use the `APIPlayground` component:
+
+```
+
+```
+
+The playground seamlessly integrates with your existing API documentation and provides a Postman-like experience directly in the docs.
+
+---

package/dist/websocket-playground-demo.mdx

@@ -0,0 +1,135 @@
+---
+title: 'WebSocket Playground Demo'
+description: 'Interactive WebSocket playground for testing real-time connections'
+---
+
+# WebSocket Playground Demo
+
+This page demonstrates the WebSocket playground component with various configuration options and real-time connection testing capabilities.
+
+## Basic WebSocket Connection
+
+<WebSocketPlayground
+  url="/ws/chat"
+  title="Basic Chat WebSocket"
+  description="Connect to a WebSocket server and send/receive messages in real-time"
+  servers={[
+    {
+      url: "wss://echo.websocket.org",
+      description: "WebSocket Echo Server"
+    },
+    {
+      url: "wss://ws.postman-echo.com/raw",
+      description: "Postman Echo WebSocket"
+    }
+  ]}
+/>
+
+## WebSocket with Subprotocols
+
+<WebSocketPlayground
+  url="/ws/protocol"
+  title="WebSocket with Subprotocols"
+  description="WebSocket connection with custom subprotocols for specialized communication"
+  subprotocols={["chat", "v1.0"]}
+  servers={[
+    {
+      url: "wss://echo.websocket.org",
+      description: "Echo Server with Subprotocols"
+    }
+  ]}
+/>
+
+## WebSocket with Authentication
+
+<WebSocketPlayground
+  url="/ws/secure"
+  title="Authenticated WebSocket"
+  description="WebSocket connection with authentication headers"
+  authType="bearer"
+  headers={{
+    "User-Agent": "Dory WebSocket Client",
+    "X-Client-Version": "1.0.0"
+  }}
+  servers={[
+    {
+      url: "wss://echo.websocket.org",
+      description: "Secure Echo Server"
+    }
+  ]}
+/>
+
+## Real-time Chat Example
+
+<WebSocketPlayground
+  url="/chat"
+  title="Real-time Chat"
+  description="Connect to a chat server and participate in real-time conversations"
+  subprotocols={["chat.v1", "json"]}
+  headers={{
+    "X-Client-Type": "web",
+    "X-Protocol-Version": "1.0"
+  }}
+  servers={[
+    {
+      url: "wss://echo.websocket.org",
+      description: "Chat Echo Server"
+    }
+  ]}
+/>
+
+## Testing Instructions
+
+1. **Connect**: Click the "Connect" button to establish a WebSocket connection
+2. **Send Messages**: Type messages in the input field and click "Send" or press Enter
+3. **View Messages**: All sent and received messages appear in the message history with timestamps
+4. **Configuration**: Use the tabs to configure headers, subprotocols, and authentication
+5. **Server Selection**: Choose different servers from the dropdown to test various endpoints
+
+## Features
+
+- **Real-time Connection**: Live WebSocket connection with status indicators
+- **Message History**: View all sent/received messages with timestamps
+- **Custom Headers**: Add authentication and custom headers
+- **Subprotocols**: Configure WebSocket subprotocols
+- **Multiple Servers**: Easy switching between different WebSocket endpoints
+- **Error Handling**: Clear error messages for connection issues
+- **Binary Support**: Handles both text and binary messages
+
+## Message Types
+
+The playground supports different message types:
+- **Sent**: Messages you send (blue background)
+- **Received**: Messages from the server (green background)
+- **Error**: Connection or sending errors (red background)
+- **System**: Connection status updates (gray background)
+
+## Example Messages
+
+Try sending these JSON messages to test structured data:
+
+```json
+{
+  "type": "chat",
+  "message": "Hello, WebSocket!",
+  "userId": "user123",
+  "timestamp": "2024-01-15T10:30:00Z"
+}
+```
+
+```json
+{
+  "type": "presence",
+  "status": "online",
+  "userId": "user123"
+}
+```
+
+```json
+{
+  "type": "notification",
+  "title": "Test Notification",
+  "message": "This is a test notification",
+  "level": "info"
+}
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clidey/dory",
   "private": false,
-  "version": "0.21.2",
+  "version": "0.22.0",
   "type": "module",
   "description": "A CLI tool for building and previewing documentation sites",
   "keywords": [
@@ -24,12 +24,6 @@
   "bugs": {
     "url": "https://github.com/clidey/dory/issues"
   },
-  "scripts": {
-    "dev": "vite",
-    "build": "tsc -b && vite build",
-    "preview": "vite preview",
-    "publish": "npm publish --access public"
-  },
   "dependencies": {
     "@algolia/autocomplete-core": "^1.19.2",
     "@fortawesome/fontawesome-svg-core": "^6.7.2",
@@ -68,8 +62,12 @@
     "vite-plugin-mdx": "^3.6.1",
     "wouter-preact": "^3.7.1"
   },
-  "packageManager": "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39",
   "devDependencies": {
     "@types/node": "^24.0.12"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "preview": "vite preview"
   }
-}
+}