forked from BarRaiders/barraiders.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
base.yml
81 lines (80 loc) · 3.03 KB
/
base.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
site_url: !ENV [SITE_NAME, 'http://docs.barraider.com']
# do_not_index: true
site_name: BarRaider's Plugin Documentation
markdown_extensions:
- admonition # Fancy callouts (https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonition-icons)
- pymdownx.details # Collapsible callouts
- pymdownx.superfences # Nest Markdown in callouts (https://facelessuser.github.io/pymdown-extensions/extensions/superfences/)
- pymdownx.keys # Render Keyboard keys with markdown (https://facelessuser.github.io/pymdown-extensions/extensions/keys/)
- md_in_html # Currently we're using this for image captions
- pymdownx.tasklist: # Support for Tabs (https://fabacademy.org/2022/labs/kannai/Instruction/tips/tab_in_markdown/)
custom_checkbox: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- meta # advanced customizable metadata
- tables
extra_javascript:
- https://unpkg.com/[email protected]/dist/tablesort.min.js
- javascripts/tablesort.js
plugins:
- search
- glightbox #fancy image zoom (https://github.com/blueswen/mkdocs-glightbox#usage)
- macros
- mkdocs-video
theme:
name: "material"
custom_dir: overrides
logo: "img/barraider-logo2.png"
features:
- navigation.instant # Makes it act like a Single-Page Application
- navigation.tabs # Top-Level Nav is rendered in the top
#- navigation.tabs.sticky # and scrolls with the page on longer pages
#- navigation.expand # Show sub-sections in left pane
- navigation.indexes # Simpler Nav for sub-sections with overview pages
# v9 specific options
- content.code.copy # copy-to-clipboard setting
- navigation.footer
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
primary: blue grey
scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
extra:
site_short_name: BarRaider Docs
logo: img/barraider-logo.avif
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
feedback:
title: Was this page helpful?
ratings:
- icon: material/thumb-up-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/thumb-down-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback!
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/realBarRaider
- icon: fontawesome/brands/discord
link: http://discord.barraider.com/
- icon: fontawesome/brands/patreon
link: https://www.patreon.com/barraider
name: Support BarRaider's Work on Patreon
- icon: fontawesome/brands/github
link: https://github.com/BarRaider