elliebot/docs/md/index.md

# EllieBot Documentation

<!-- ![img][header] -->

## Inviting Ellie

There are two versions of Ellie, a public bot and a self-hostable bot.

To invite public Ellie to your server or to view its commands, click on the buttons below:

[:material-plus: Add Ellie to your server][invite]{ .md-button .md-button--primary }
[:material-format-list-text: View commands][commands]{ .md-button }

To self-host your own Ellie, use the guides below:

- [:material-television-guide: Desktop guide (Windows/Linux/macOS)][desktop-guide]
- [:material-console: CLI guide (Linux/macOS)][cli-guide]
- [:material-docker: Docker guide][docker-guide]
- [:material-source-branch: From source guide][from-source-guide]

In case you need any help, join our [Discord server][discord-server] where we may provide support.

## About Ellie

EllieBot is an [open source project][toastielab]. Any issues with the bot may be filed [here][issues].

If you're unsure whether something is an issue, ask in our support server first.

[Donations are welcome][donate], and we rely on your contributions to help keep the project alive.

[invite]: https://discordapp.com/oauth2/authorize?client_id=608119997713350679&scope=bot&permissions=66186303/
[commands]: https://commands.elliebot.net/
[desktop-guide]: ./guides/desktop-guide.md
[cli-guide]: ./guides/cli-guide.md
[docker-guide]: ./guides/docker-guide.md
[from-source-guide]: ./guides/source-guide.md
[discord-server]: https://discord.gg/etQdZxSyEH
[toastielab]: https://toastielab.dev/EllieBotDevs/elliebot
[issues]: https://toastielab.dev/EllieBotDevs/elliebot/issues
[donate]: ./donate.md