docs: Add initial docs

This commit is contained in:
Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs 2022-08-07 16:32:24 +02:00
parent 155946fb1e
commit 567577762f
No known key found for this signature in database
GPG key ID: BC5E2BD907F9A8EC
15 changed files with 819 additions and 11 deletions

83
.ci/mkdocs/mkdocs.yaml Normal file
View file

@ -0,0 +1,83 @@
---
# Project information
site_name: bjw-s | Helm charts | Docs
site_description: Docs for the bjw-s Helm charts repository
site_author: bjw-s
site_url: https://bjw-s.github.io/helm-charts/docs
# Repository
repo_name: bjw-s/helm-charts
repo_url: https://github.com/bjw-s/helm-charts
edit_uri: ""
# Configuration
theme:
name: material
icon:
repo: fontawesome/brands/github-alt
language: en
features:
- navigation.sections
- navigation.tabs
- navigation.tracking
# - navigation.indexes
- search.highlight
- search.share
- search.suggest
palette:
- scheme: default
primary: blue
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: blue
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
docs_dir: ../../docs
site_dir: ../../_site
extra_css:
- _static/custom.css
# Plugins
plugins:
- search
- minify:
minify_html: true
# Customization
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/bjw-s
- icon: fontawesome/brands/discord
link: https://discord.gg/sTMX7Vh
# Extensions
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
# Page tree
nav:
- Home: index.md
- Common Library:
- Introduction: common-library/introduction.md
- Common Storage: common-library/common-library-storage.md
- Common Add-ons: common-library/common-library-add-ons.md

View file

@ -0,0 +1,5 @@
mkdocs==1.3.1
mkdocs-macros-plugin ==0.7.0
mkdocs-material ==8.3.9
mkdocs-minify-plugin==0.5.0
mkdocs-redirects==1.0.5