diff --git a/docs/md/assets/favicon.png b/docs/md/assets/favicon.png new file mode 100644 index 0000000..c338b09 Binary files /dev/null and b/docs/md/assets/favicon.png differ diff --git a/docs/md/index.md b/docs/md/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/md/index.md @@ -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. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..b358a36 --- /dev/null +++ b/docs/mkdocs.yml @@ -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 \ No newline at end of file