> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blode.md/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

Go from zero to deployed documentation in five 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 blodemd
```
  1. **Authenticate**

```bash
    blodemd login
    ```

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

```bash
    blodemd 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 `blodemd 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
    blodemd push docs
    ```

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

## 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