DevDeck Docs

Scale your technical documentation with global edge distribution. Write beautiful docs with Markdown, AI search, and automatic versioning.

Getting Started

DevDeck Docs expects a /docs folder in your repository. Our engine will automatically scan this folder and build your documentation site on every commit.

Configuration

Create a devdeck.docs.json in your project root:

{
  "title": "My Awesome Library",
  "theme": "dark",
  "basePath": "/docs"
}

Markdown Support

We support GitHub Flavored Markdown (GFM) with additional extensions for documentation, like alerts, code blocks with copy buttons, and Mermaid diagrams.

# Introduction
This is an alert:
> [!TIP]
> This is a helpful tip!

```javascript
console.log('Hello DevDeck!');
```

Versioning

Automatic versioning allows your users to see documentation for legacy releases while you focus on the latest version. Simply tag your releases in Git, and we'll do the rest.