-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
107 lines (102 loc) · 3.22 KB
/
mkdocs.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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# Project Information
site_name: FFXIVITA Docs
site_url: https://docs.ffxivita/
site_description: Comprehensive documentation for FFXIVITA
# repo allows for linking main repo to docs
# Uncomment to use
repo_url: https://gitlab.com/ffxivita/Siren/
repo_name: ffxivita/Siren
edit_uri: "" #removes edit button and icon
copyright: Powered by <a href="https://vercel.com/?utm_source=ffxivita&utm_campaign=oss" target="_blank">
<img src="/assets/images/vercel-logotype-light.svg" alt="Vercel Logo"></a>
# Configuration
theme:
name: material
# Theme Overhaul configuration. Use with caution.
# Uncommenting custom_dir requires additional setup.
custom_dir: overrides
logo: assets/images/ffxivita.svg
font:
text: Inter
palette:
scheme: slate
features:
- navigation.tabs
- navigation.tabs.sticky
# Temporarily deactivated to provide support for Discord browser + anchor links
# - navigation.instant
- navigation.top
- navigation.tracking
- search.suggest
- search.highlight
- search.share
favicon: assets/images/ffxivita.svg
# Plugins
plugins:
search:
lang: en
# Comment out the plugin below if building docs without an internet connection.
external-markdown: {}
awesome-pages: {}
tags: {}
git-revision-date-localized:
type: date
mkdocs-video:
mark: "video-embed"
glightbox:
touchNavigation: true
loop: false
effect: zoom
width: 100%
height: auto
zoomable: true
draggable: true
skip_classes:
- skip-lightbox
auto_caption: false
caption_position: bottom
# Styling Front-end
extra_css:
- stylesheets/extra.css
- stylesheets/admonitions.css
- stylesheets/navigation.css
# Extra Functions / Customizations
extra:
social:
- icon: fontawesome/brands/gitlab
link: https://gitlab.com/ffxivita
name: FFXIVITA on GitLab
- icon: fontawesome/brands/twitter
link: https://twitter.com/ffxiv_it
name: FFXIVITA on Twitter
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/FFXIVITA
name: FFXIVITA on Facebook
- icon: fontawesome/brands/discord
link: https://dsc.gg/ffxvita
name: FFXIVITA on Discord
- icon: fontawesome/brands/twitch
link: https://www.twitch.tv/FFXIVITA
name: FFXIVITA on Twitch
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@FFXIVITA
name: FFXIVITA on Youtube
# Additional Markdown Extensions to use bundled icon sets
markdown_extensions:
meta: {} # Add front matter to a document
admonition: {} # Makes things pretty
pymdownx.superfences: {} # Nestled code
attr_list: {} # Add HTML attributes and CSS classes to Markdown elements
pymdownx.tabbed: # Content tabs
alternate_style: true
pymdownx.details: {} # Additional features to admonition
pymdownx.caret: {} # Formatting Extension
pymdownx.critic: {} # Alternate Formatting Extension
pymdownx.mark: {} # Formatting Extension
pymdownx.tilde: {} # Formatting Extension
pymdownx.keys: {} # Visual keyboard keys extension
pymdownx.tasklist:
custom_checkbox: true
pymdownx.emoji: # Allows emoji style inline embeds for icons
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg