Initial commit
This commit is contained in:
parent
66428c9653
commit
358854e6fa
4 changed files with 2105 additions and 0 deletions
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
.cache/
|
||||
site/
|
||||
2036
docs/assets/logo.svg
Normal file
2036
docs/assets/logo.svg
Normal file
File diff suppressed because it is too large
Load diff
|
After Width: | Height: | Size: 65 KiB |
17
docs/index.md
Normal file
17
docs/index.md
Normal 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.
|
||||
50
mkdocs.yml
Normal file
50
mkdocs.yml
Normal file
|
|
@ -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
|
||||
Loading…
Add table
Add a link
Reference in a new issue