From 8505132021d56da89de36efe46b5aea1d15d57fa Mon Sep 17 00:00:00 2001 From: Juli Date: Mon, 22 Jul 2024 21:27:33 +0300 Subject: [PATCH] made project and config --- .gitignore | 1 + docs/index.md | 17 +++++++++ mkdocs.yml | 61 +++++++++++++++++++++++++++++++++ overrides/.icons/icons/fedi.svg | 6 ++++ overrides/fedi.svg | 6 ++++ 5 files changed, 91 insertions(+) create mode 100644 .gitignore create mode 100644 docs/index.md create mode 100644 mkdocs.yml create mode 100644 overrides/.icons/icons/fedi.svg create mode 100644 overrides/fedi.svg diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1998c29 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.cache \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/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/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b9c53a6 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,61 @@ +site_name: My Docs +theme: + name: material + font: + code: Fira Codes + custom_dir: overrides + site_url: https://docs.julimiro.eu + palette: + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: pink + accent: pink + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: pink + accent: pink + toggle: + icon: material/brightness-4 + name: Switch to system preference + + features: + - navigation.footer + - search.suggest + - search.highlight + - search.share + - navigation.instant + - navigation.instant.prefetch + - navigation.instant.progress + - navigation.tracking + - navigation.path + - navigation.indexes + - navigation.top + +plugins: + - search + - privacy + +extra: + social: + - icon: fontawesome/brands/git-alt + link: https://git.gay/Julimiro/ + name: Julimiro on git.gay + + - icon: icons/fedi + link: https://eepykitty.lol/@juli + name: "@juli on eepykitty.lol" + + + +copyright: Copyright © 2024 Julimiro \ No newline at end of file diff --git a/overrides/.icons/icons/fedi.svg b/overrides/.icons/icons/fedi.svg new file mode 100644 index 0000000..afbc915 --- /dev/null +++ b/overrides/.icons/icons/fedi.svg @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/overrides/fedi.svg b/overrides/fedi.svg new file mode 100644 index 0000000..afbc915 --- /dev/null +++ b/overrides/fedi.svg @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file