sdk.as
Preview MDXLD as SDK documentation with live examples
sdk.as - SDK Documentation
Preview MDXLD SDK definitions with live code examples and interactive playground through sdk.as.
What is sdk.as?
sdk.as renders MDXLD documents with $type: SDK as comprehensive SDK documentation with live, editable code examples that run in the browser.
Basic Example
---
$type: SDK
$id: https://sdk.do/users-sdk
name: Users SDK
language: typescript
package: '@example/users-sdk'
version: 1.0.0
install: npm install @example/users-sdk
---
# Users SDK
TypeScript SDK for the Users API.
## Installation
\`\`\`bash
npm install @example/users-sdk
\`\`\`
## Usage
\`\`\`typescript
import { UsersClient } from '@example/users-sdk'
const client = new UsersClient({
apiKey: 'your-api-key'
})
const users = await client.users.list()
\`\`\`
export const examples = {
basic: \`
const client = new UsersClient({ apiKey: 'key' })
const users = await client.users.list()
console.log(users)
\`
}Renders at: https://sdk.as/users-sdk
Features
- Live Examples: Edit and run code in browser
- Type Definitions: Full TypeScript support
- Code Playground: Interactive code editor
- Multiple Languages: Support for JS, TS, Python, Go, etc.
- Installation Guide: Package manager instructions
- API Reference: Auto-generated from types
SDK Definition
---
$type: SDK
name: Payment SDK
languages:
- typescript
- python
- go
modules:
- payments
- subscriptions
- customers
---Live Playground
Users can edit and run examples:
// Editable code
const client = new PaymentClient()
const payment = await client.payments.create({
amount: 1000,
currency: 'usd'
})
// Click "Run" to see output
console.log(payment)Preview URL
Try It
# Deploy SDK docs
mdxe deploy payment-sdk.mdx --preview sdk.as
# Opens: https://sdk.as/payment-sdk