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

# Quickstart

> Install the binary, scaffold a resume, render every format.

## 1. Install

<Tabs>
  <Tab title="Go install">
    ```bash theme={null}
    go install github.com/ovsec/resumelang@latest
    ```
  </Tab>

  <Tab title="From source">
    ```bash theme={null}
    git clone https://github.com/ovsec/resumelang.git
    cd resumelang
    go build -o resumelang .
    ```
  </Tab>

  <Tab title="Homebrew (planned)">
    ```bash theme={null}
    brew install ovsec/tap/resumelang
    ```
  </Tab>
</Tabs>

Verify:

```bash theme={null}
resumelang version
```

## 2. Scaffold a resume

```bash theme={null}
resumelang init
# → created resume.yml
```

The starter file already includes:

```yaml theme={null}
# yaml-language-server: $schema=https://resumelang.dev/schema/v1.json
resumelang: v1

meta:
  theme: minimal
```

That preamble unlocks autocomplete and red-squiggle validation in any editor
that speaks the YAML language server (VS Code, Neovim, JetBrains).

## 3. Build every format

```bash theme={null}
resumelang build resume.yml
```

You get:

```text theme={null}
dist/
├── resume.html
├── resume.json    # JSON Resume schema
├── resume.md      # GitHub-flavored markdown
└── resume.txt     # ATS-safe plain text
```

PDF is one keystroke away — open `dist/resume.html` in a browser and print.

## 4. Switch theme

Either change `meta.theme` in the YAML file, or build with a flag:

```bash theme={null}
resumelang build resume.yml --formats html
```

Built-in themes: `minimal`, `aurora`, `material`, `terminal`, `sap`. See
[Themes](/themes) for previews and how to add your own.

## 5. Open the live editor

```bash theme={null}
resumelang serve
# → http://127.0.0.1:5500
```

Edit YAML on the left, watch the preview re-render on the right. Drag the
splitter, switch themes, hit Print to save as PDF. Drafts auto-save to the
browser's localStorage so you can close the tab without losing work.

## 6. Ship it

<Columns cols={2}>
  <Card title="Publish via GitHub Actions" icon="github" href="/ci">
    Every push to `resume.yml` rebuilds and deploys to GitHub Pages.
  </Card>

  <Card title="Use the VS Code extension" icon="code" href="/extension">
    Inline preview, schema validation, theme picker — without leaving your editor.
  </Card>
</Columns>

## What's next

<CardGroup cols={2}>
  <Card title="DSL schema" icon="code" href="/schema">
    Every field in `resume.yml`, with examples.
  </Card>

  <Card title="CLI reference" icon="terminal" href="/cli">
    All commands and flags in one page.
  </Card>
</CardGroup>