> ## Documentation Index
> [HTML page](https://blode.md/docs/quickstart)
> [Documentation index](https://blode.md/docs/llms.txt)
> Use the index to discover all available pages before exploring further.

# Quickstart

Install the Edda CLI, authenticate with GitHub, scaffold a docs project with edda new, preview locally, and deploy live docs in minutes.

This guide walks you through installing the CLI, scaffolding a docs project, and deploying it.

## Prerequisites

You need [Node.js](https://nodejs.org) 24.x.

## Steps

  1. **Install the CLI**

```bash
npm i -g edda-docs
```
  1. **Authenticate**

```bash
edda login
```

This opens your browser for OAuth authentication. Use `edda login --token` to paste an API key instead.
  1. **Scaffold your docs**

```bash
edda new
```

In a non-empty repo, the CLI recommends creating a `docs/` subdirectory. Choosing that path creates:

  - docs/
    - docs.json
    - index.mdx

If you want to scaffold the current directory instead, run `edda new .`.

For a fuller kit with `.gitignore`, `README.md`, `AGENTS.md`, `CLAUDE.md`, `favicon.svg`, `logo/`, and `images/`, add `--template starter`.
  1. **Review your project slug**

The scaffold writes both `name` and `slug` into `docs/docs.json`. Change `slug` later if you want a different subdomain, and change `name` if you want a different visible site title:

```json title="docs/docs.json"
{
  "$schema": "https://blode.md/docs.json",
  "name": "Acme Docs",
  "slug": "acme-docs",
  "navigation": {
    "groups": [{ "group": "Getting Started", "pages": ["index"] }]
  }
}
```
  1. **Deploy**

```bash
edda push docs
```

Your docs are live at `your-slug.blode.md`.

## Prefer GitHub?

Auto-deploy from a GitHub repo works once the repo already has a docs folder
with `docs.json` (scaffold it with `edda new docs`, then commit). In the
dashboard, open your project → **Git**, install the Edda GitHub App, and
point at that folder. Connecting an empty repo will fail until the folder
exists.

## What's next

- [Configure navigation and branding](/configuration/docs-json)
- [Add MDX components](/content/mdx-basics) to your pages
- [Run a local dev server](/features/dev-server) for real-time preview