Local Development

Set up local development for advanced customization and faster iteration.

Installing the CLI

The AlgoQuill CLI allows you to develop your docs locally, preview changes in real-time, and deploy from the command line.

# Install the AlgoQuill CLI globally
npm install -g @algoquill/cli

# Verify installation
algoquill --version

Initialize a Project

Create a new AlgoQuill project or connect to an existing one.

# Create a new project
algoquill init my-docs

# Or connect to existing project
algoquill init --project-id abc123

Development Server

Start the local development server with hot reloading.

# Start dev server
cd my-docs
algoquill dev

# Server runs at http://localhost:3333

Project Structure

A AlgoQuill project has the following structure:

my-docs/
├── algoquill.json          # Project configuration
├── pages/
│   ├── introduction.mdx
│   ├── quickstart.mdx
│   └── guides/
│       ├── getting-started.mdx
│       └── advanced.mdx
├── components/         # Custom components
├── public/            # Static assets
└── styles/            # Custom CSS

CLI Commands