docs.as - Documentation Preview

Preview MDXLD documentation with sidebar navigation, search, and table of contents through docs.as.

What is docs.as?

docs.as renders MDXLD documents with $type: Documentation as beautiful, searchable documentation with automatic navigation and organization.

Basic Example

---
$type: Documentation
$id: https://docs.do/getting-started
title: Getting Started
category: Guides
sidebar:
  - Installation
  - Configuration
  - First Steps
  - Troubleshooting
---

# Getting Started

Welcome to our documentation! This guide will help you get started.

## Installation

Install the package using your favorite package manager:

\`\`\`bash
npm install @example/package
\`\`\`

## Configuration

Create a config file...

Renders at: https://docs.as/getting-started

Features

Sidebar Navigation: Auto-generated from structure
Search: Full-text search across all docs
Table of Contents: In-page navigation
Breadcrumbs: Show current location
Versioning: Multiple doc versions
Dark Mode: Theme switching
Mobile Responsive: Perfect on all devices

Documentation Structure

---
$type: Documentation
sidebar:
  - title: Getting Started
    items:
      - Installation
      - Configuration
  - title: Guides
    items:
      - Basic Usage
      - Advanced Topics
  - title: API Reference
    items:
      - Functions
      - Types
---

Search Integration

Full-text search automatically indexes:

Document titles
Headings
Content
Code examples

Preview URL

https://docs.as/{project}
https://docs.as/{project}/category/page

Try It

# Deploy docs directory
mdxe deploy ./docs --preview docs.as

# Opens: https://docs.as/project with full navigation

docs.as

On this page