# Installation :partyparrot:

## Install with uv (Recommended) :stonks:

```bash
uv add mkdocs-external-custom-emojis
```

## Install with pip

```bash
pip install mkdocs-external-custom-emojis
```

## Requirements

- Python 3.11+
- MkDocs 1.4+
- MkDocs Material 9.4+

## Install from Source :bob_the_builder:

For development or bleeding-edge features:

```bash
git clone https://github.com/julie-dujardin/mkdocs-external-custom-emojis.git
cd mkdocs-external-custom-emojis
uv sync --dev
```

## Verify Installation :lgtm:

```bash
mkdocs-emoji --version
```

You should see:

```
mkdocs-emoji, version 0.1.0
```

You're all set! :confettis:

## Next Steps

- [Quick Start Guide](quickstart.md) - Get up and running in 5 minutes :fastparrot:
- [Configuration](configuration.md) - Learn about configuration options :claudethinking:
