From 358854e6fa61cfd76407ae976055f0fe588b9535 Mon Sep 17 00:00:00 2001 From: Cory <16737666+corybiscuit@users.noreply.github.com> Date: Sat, 12 Jul 2025 18:56:03 -0400 Subject: [PATCH] Initial commit --- .gitignore | 2 + docs/assets/logo.svg | 2036 ++++++++++++++++++++++++++++++++++++++++++ docs/index.md | 17 + mkdocs.yml | 50 ++ 4 files changed, 2105 insertions(+) create mode 100644 .gitignore create mode 100644 docs/assets/logo.svg create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..010ee5f --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.cache/ +site/ \ No newline at end of file diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 0000000..4aa4ab9 --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1,2036 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 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..06f3b88 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,50 @@ +# MkDocs configuration file + + +# Project information +site_name: bsct.me docs +site_url: https://docs.bsct.me/ +site_description: Technical documentation maintained by corybiscuit +site_author: corybiscuit + +# Copyright information +copyright: Copyright © 2025 corybiscuit + +# Repository information +repo_url: https://git.bsct.me/corybiscuit/docs.bsct.me +repo_name: corybiscuit/docs.bsct.me + +# Theme configuration +theme: + name: material + features: + - navigation.instant + - navigation.instant.progress + - navigation.tracking + - navigation.path + - navigation.indexes + - navigation.top + - navigation.footer + - toc.follow + - search.suggest + - search.highlight + palette:: + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/lightbulb + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + logo: assets/logo.svg + favicon: assets/logo.svg + font: + text: Public Sans + code: JetBrains Mono +plugins: + - privacy + - search + - tags \ No newline at end of file