-
Notifications
You must be signed in to change notification settings - Fork 11
/
mkdocs.yml
118 lines (107 loc) · 3.37 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
108
109
110
111
112
113
114
115
116
117
118
# Project info
site_name: Mentored Sprints Community Handbook
site_description: Field notes to run open source sprints
# Repo
repo_name: pycon-mentored-sprints/community-handbook
edit_uri: edit/main/docs/
repo_url: https://github.com/pycon-mentored-sprints/community-handbook
# Copyright
copyright: Copyright © 2018-2023 Mentored Sprints
# Configuration
theme:
name: material
palette:
- media: "(preference-color-scheme: light)"
scheme: ms-light
primary: ms-blue
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(preference-color-scheme: dark)"
scheme: ms-dark
primary: ms-blue
toggle:
icon: material/weather-sunny
name: Switch to light mode
icon:
repo: octicons/mark-github-16
admonition:
example: octicons/feed-star-16
logo: assets/community_handbook_white_trans.svg
# Navigation
features:
- navigation.tracking
- navigation.top
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.path
- navigation.footer
font:
text: Obliqua
code: Inconsolata
favicon: assets/favicon/favicon.ico
language: en
extra_css:
- stylesheets/css/custom.css
# Social links
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/mentoredsprints
name: Mentored Sprints Twitter account
- icon: octicons/mark-github-16
link: https://github.com/pycon-mentored-sprints
name: Mentored Sprints GitHub
- icon: octicons/mail-16
link: mailto:[email protected]
- icon: fontawesome/brands/discord
link: https://discord.gg/H4fYmEe
name: Mentored Sprints Discord Server
# Mentored Sprints are cool!
# Extensions
markdown_extensions:
- meta
- admonition
- pymdownx.highlight:
linenums: true
- pymdownx.superfences
- pymdownx.inlinehilite
- toc:
permalink: true
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
plugins:
- search
- git-revision-date-localized
- minify:
minify_html: true
# TODO: add custom meta tags - https://squidfunk.github.io/mkdocs-material/reference/meta-tags/
# Page tree
nav:
- Home: index.md
- About: about.md
- Code of conduct:
- Introduction: code-of-conduct/01-index.md
- CoC in detail: code-of-conduct/02-coc-detail.md
- Reporting Guidelines: code-of-conduct/03-reporting.md
- Enforcement Manual: code-of-conduct/04-enforcement.md
- Acknowledgment: code-of-conduct/05-acknowledgement.md
- Organisers:
- Getting Started: organisers/01-index.md
- Roles and People: organisers/02-people.md
- Tools and Apps: organisers/03-tools.md
- Participants:
- Contribution Sprints 101: participants/01-index.md
- Asking Good Questions: participants/02-asking-questions.md
- Git for contributors: participants/03-git-contributors.md
- Git etiquette for contributors: participants/04-git-etiquette.md
- Online - Mentored Sprints: participants/05-online-sprints.md
- Mentors:
- Mentored Sprints: mentors/01-index.md
- In-person - preparation: mentors/02-prepare.md
- Online - preparation: mentors/02-prepare-online.md
- Online - technical setup: mentors/03-online-setup.md
- Our Discord server: mentors/04-discord.md