Skip to content

Commit ba45df6

Browse files
further refining theming
adding theme settings, and adding material plugins
1 parent 1153b0c commit ba45df6

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

.github/workflows/deploy.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ jobs:
1818
- name: Install deps
1919
run: |
2020
python -m pip install --upgrade pip
21-
pip install mkdocs mkdocs-material
21+
pip install mkdocs mkdocs-material \
22+
mkdocs-material[imaging] \
23+
mkdocs-social-tags-plugin \
24+
mkdocs-git-revision-date-localized-plugin \
2225
- name: Deploy
2326
run: |
2427
mkdocs gh-deploy --force

mkdocs.yml

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,23 @@ site_description: Official documentation for Pirate MIDI products and tools
33
site_url: https://docs.piratemidi.com
44

55
theme:
6+
language: en
67
favicon: assets/favicon.png
78
logo: assets/logo-white.svg
89
name: material
910
features:
11+
- header.autohide
1012
- navigation.tabs
11-
- navigation.sections
13+
- navigation.instant
14+
- navigation.instant.progress
15+
- navigation.tracking
16+
- navigation.path
17+
- navigation.footer
18+
- toc.integrate
1219
- content.code.copy
1320
- search.suggest
1421
- search.highlight
22+
- search.share
1523
palette:
1624
- media: "(prefers-color-scheme: light)"
1725
scheme: default
@@ -30,6 +38,13 @@ theme:
3038

3139
plugins:
3240
- search
41+
- social:
42+
cards_color: "#5B8DCA" # background color for social preview cards
43+
cards_font: Montserrat
44+
- git-revision-date-localized:
45+
enable_creation_date: true
46+
type: timeago
47+
enable_creation_date: true
3348

3449
markdown_extensions:
3550
- admonition
@@ -57,5 +72,13 @@ nav:
5772
extra_css:
5873
- assets/branding.css
5974

60-
extra_javascript:
61-
- assets/logo-switch.js
75+
extra:
76+
social:
77+
- icon: fontawesome/brands/discord
78+
link: https://discord.gg/x722K7ksA6
79+
- icon: fontawesome/brands/youtube
80+
link: https://youtube.com/c/piratemidi
81+
- icon: fontawesome/brands/facebook
82+
link: https://facebook.com/groups/pirate.midi.users
83+
- icon: fontawesome/brands/instagram
84+
link: https://instagram.com/piratemidi

0 commit comments

Comments
 (0)