# Installation

This guide covers how to install Great Docs and its prerequisites.


# Prerequisites

Before installing Great Docs, ensure you have:

- **Python 3.11 or later**
- **Quarto** - The publishing system that renders your documentation


## Installing Quarto

Great Docs uses Quarto to render documentation. Install it from [quarto.org](https://quarto.org/docs/get-started/):


- <a href="" id="tabset-1-1-tab" class="nav-link active" data-bs-toggle="tab" data-bs-target="#tabset-1-1" role="tab" aria-controls="tabset-1-1" aria-selected="true">macOS</a>
- <a href="" id="tabset-1-2-tab" class="nav-link" data-bs-toggle="tab" data-bs-target="#tabset-1-2" role="tab" aria-controls="tabset-1-2" aria-selected="false">Linux</a>
- <a href="" id="tabset-1-3-tab" class="nav-link" data-bs-toggle="tab" data-bs-target="#tabset-1-3" role="tab" aria-controls="tabset-1-3" aria-selected="false">Windows</a>


    Terminal


``` bash
# Using Homebrew
brew install quarto

# Or download the installer from quarto.org
```


    Terminal


``` bash
# Download and install the .deb package (Ubuntu/Debian)
# Get the latest release URL from https://quarto.org/docs/get-started/
wget <quarto-release-url>.deb
sudo dpkg -i <quarto-release-filename>.deb

# Or use your package manager
```


Download and run the installer from [quarto.org](https://quarto.org/docs/get-started/).


Verify the installation:


    Terminal


``` bash
quarto --version
```


# Installing Great Docs


## From PyPI

The simplest way to install Great Docs:


    Terminal


``` bash
pip install great-docs
```


## From GitHub

Install the latest development version directly from GitHub:


    Terminal


``` bash
pip install git+https://github.com/posit-dev/great-docs.git
```


Or install a specific version:


    Terminal


``` bash
# Install from a specific branch
pip install git+https://github.com/posit-dev/great-docs.git@main

# Install from a specific tag
pip install git+https://github.com/posit-dev/great-docs.git@v0.1.0
```


## Development Installation

For contributing to Great Docs or testing the latest features:


    Terminal


``` bash
# Clone the repository
git clone https://github.com/posit-dev/great-docs.git
cd great-docs

# Install in editable mode
pip install -e .

# Or with development dependencies
pip install -e ".[dev]"
```


# Verify Installation

After installation, verify everything is working:


    Terminal


``` bash
# Check Great Docs version
great-docs --help

# Check Quarto version
quarto --version
```


You should see the Great Docs help message and the Quarto version number.


# Next Steps

With Great Docs and Quarto installed, you're ready to generate your first documentation site.

- [Quick Start](quickstart.md) walks you through `great-docs init` and `great-docs build`
- [Configuration](configuration.md) covers customizing behavior through `great-docs.yml`