Skip to content

Commit

Permalink
- Add mkdocs.yml settings file
Browse files Browse the repository at this point in the history
  • Loading branch information
MariusStorhaug committed Jul 20, 2024
1 parent 6823f93 commit 0d1fd86
Showing 1 changed file with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
site_name: -{{ REPO_NAME }}-
theme:
name: material
language: en
font:
text: Roboto
code: Sono
logo: Assets/icon.png
favicon: Assets/icon.png
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/link
name: Switch to dark mode
# Palette toggle for dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
toggle:
primary: black
accent: green
icon: material/toggle-switch-off-outline
name: Switch to light mode
# Palette toggle for light mode
- media: '(prefers-color-scheme: light)'
scheme: default
toggle:
primary: indigo
accent: green
icon: material/toggle-switch
name: Switch to system preference
icon:
repo: material/github
features:
- navigation.instant
- navigation.instant.progress
- navigation.indexes
- navigation.top
- navigation.tracking
- navigation.expand
- search.suggest
- search.highlight

repo_name: -{{ REPO_OWNER }}-/-{{ REPO_NAME }}-
repo_url: https://github.com/-{{ REPO_OWNER }}-/-{{ REPO_NAME }}-

plugins:
- search

markdown_extensions:
- toc:
permalink: true # Adds a link icon to headings
- attr_list
- admonition
- md_in_html
- pymdownx.details # Enables collapsible admonitions

extra:
social:
- icon: fontawesome/brands/discord
link: https://discord.gg/jedJWCPAhD
name: -{{ REPO_OWNER }}- on Discord
- icon: fontawesome/brands/github
link: https://github.com/-{{ REPO_OWNER }}-/
name: -{{ REPO_OWNER }}- on GitHub
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
actions:
- accept
- reject

0 comments on commit 0d1fd86

Please sign in to comment.