# Quickstart

<Steps>
  <Step title="Install">
    Install Writedocs globally, once, on your machine:

    ```bash
    npm install -g writedocs
    ```

    That's it — no per-project dependency, no `package.json` needed in your docs folder at all. `writedocs` is now a command available in any folder you `cd` into. Prefer not to install anything? Every command below also works prefixed with `npx` instead (`npx writedocs dev`), which downloads and runs it on the fly without a global install.
  </Step>
  <Step title="Scaffold a project">
    ```bash
    cd my-docs   # any folder — new or existing
    writedocs init
    ```

    This creates `writedocs.json` and a starter `docs/` folder (`index.mdx` and `getting-started.mdx`) in the current directory. Pass a path to scaffold somewhere else without `cd`-ing first: `writedocs init ./my-docs`.
  </Step>
  <Step title="Preview locally">
    ```bash
    writedocs dev
    ```

    Run from inside your docs project's own folder — the same one `writedocs.json` lives in. Starts a local dev server with hot reload. Open the printed URL (`http://localhost:4321` by default) to see your site.
  </Step>
  <Step title="Ship it">
    `writedocs dev` is for writing and previewing — building the static site and deploying it is handled separately, not run by every contributor locally. Push your changes and it's picked up from there.
  </Step>
</Steps>

## Next steps

<CardGroup cols={2}>
  <Card title="Configure navigation" icon="list-tree" href="/docs/configuration/navigation-basics/">
    Organize your sidebar with groups, or switch to tabs/versions for larger sites.
  </Card>
  <Card title="Explore components" icon="puzzle" href="/docs/content/components/">
    Callouts, cards, tabs, steps, and more — available in every page automatically.
  </Card>
  <Card title="Add an API reference" icon="webhook" href="/docs/openapi/overview/">
    Point a navigation group at an OpenAPI spec to get an interactive reference for free.
  </Card>
  <Card title="Full CLI reference" icon="terminal" href="/docs/cli/">
    Every command and flag `writedocs` supports.
  </Card>
</CardGroup>