Initial stuff.

This commit is contained in:
Toastie 2025-04-01 13:04:14 +13:00
parent 4a19d91a4f
commit 026e5a151e
Signed by: toastie_t0ast
GPG key ID: 74226CF45EEE5AAF
3 changed files with 74 additions and 0 deletions

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

Binary file not shown.

After

(image error) Size: 273 KiB

17
docs/md/index.md Normal file
View file

@ -0,0 +1,17 @@
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## Commands
* `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.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

57
docs/mkdocs.yml Normal file
View file

@ -0,0 +1,57 @@
site_name: EllieBot docs
site_url: https://docs.elliebot.net
repo_url: 'https://toastielab.dev/EllieBotDevs/elliebot'
site_author: Toastie_t0ast
docs_dir: 'md'
theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: blue
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: blue
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- navigation.instant
- navigation.expand
- navigation.top
font:
text: Source Sans Pro
code: Source Code Pro
logo: assets/favicon.png
favicon: assets/favicon.png
icon:
repo: material/git
extra:
homepage: https://elliebot.net
plugins:
- search
- exclude:
glob:
- 'guides/vps-linux-guide.md'
- 'snippets/supported-platforms.md'
markdown_extensions:
- attr_list
- codehilite:
guess_lang: false
- toc:
permalink: true
- pymdownx.betterem:
smart_enable: all
- admonition
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.blocks.tab:
alternate_style: true
- pymdownx.snippets
- pymdownx.details