Added more files.

This commit is contained in:
Toastie 2025-04-01 13:17:02 +13:00
parent 026e5a151e
commit 9aa567b276
Signed by: toastie_t0ast
GPG key ID: 74226CF45EEE5AAF
5 changed files with 60 additions and 13 deletions

BIN
docs/md/assets/patreon.png Normal file

Binary file not shown.

After

(image error) Size: 28 KiB

BIN
docs/md/assets/paypal.png Normal file

Binary file not shown.

After

(image error) Size: 27 KiB

View file

@ -1,17 +1,40 @@
# Welcome to MkDocs
# EllieBot Documentation
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
<!-- ![img][header] -->
## Commands
## Inviting Ellie
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
There are two versions of Ellie, a public bot and a self-hostable bot.
## Project layout
To invite public Ellie to your server or to view its commands, click on the buttons below:
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
[: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.elliebot.net/
[github]: https://toastielab.dev/EllieBotDevs/elliebot
[issues]: https://toastielab.dev/EllieBotDevs/elliebot/issues
[donate]: ./donate.md

View file

@ -0,0 +1,18 @@
<!-- TODO: These should potentially be reformated to be more readable... -->
--8<-- [start:windows]
- **Windows 10** or later (64-bit)
--8<-- [end:windows]
--8<-- [start:linux]
- **Ubuntu**: 20.04, 22.04, 24.04
- **Mint**: 19, 20, 21
- **Debian**: 10, 11, 12
- **RockyLinux**: 8, 9
- **AlmaLinux**: 8, 9
- **openSUSE Leap**: 15.5, 15.6
- **openSUSE Tumbleweed**
- **Fedora**: 38, 39, 40, 41, 42
- **Arch** & **Artix**
--8<-- [end:linux]
--8<-- [start:macos]
- **macOS 13 (Ventura)** or later
--8<-- [end:macos]

View file

@ -54,4 +54,10 @@ markdown_extensions:
- pymdownx.blocks.tab:
alternate_style: true
- pymdownx.snippets
- pymdownx.details
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons