Skip to content

Commit b5cf38f

Browse files
authored
Merge branch 'master' into update-to-mermaid-10.6.0
2 parents 441e05b + c2da2d8 commit b5cf38f

File tree

111 files changed

+3196
-6088
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+3196
-6088
lines changed
27.7 KB
Loading

CHANGELOG

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
1+
mkdocs-material-9.4.12+insiders-4.45.0 (2023-11-24)
2+
3+
* Added support for sorting blog categories by post count or custom function
4+
* Improved tags plugin to generate Unicode-aware slugs by default
5+
* Fixed non-deterministic order of multiple authors in blog plugin
6+
7+
mkdocs-material-9.4.12 (2023-11-24)
8+
9+
* Improved blog plugin to generate Unicode-aware slugs by default
10+
* Fixed non-deterministic order of categories in blog plugin
11+
12+
mkdocs-material-9.4.11+insiders-4.44.0 (2023-11-23)
13+
14+
* Added pagination settings for archive pages in blog plugin
15+
* Added pagination settings for category pages in blog plugin
16+
17+
mkdocs-material-9.4.11 (2023-11-23)
18+
19+
* Fixed #6364: Search plugin crashing when enabling theme while serving
20+
* Fixed blog plugin crashing when disabling pagination
21+
22+
mkdocs-material-9.4.10+insiders-4.43.1 (2023-11-19)
23+
24+
* Added third-party theme support in projects plugin, improving editing
25+
* Fixed #6360: Projects plugin crashes when theme is not Material for MkDocs
26+
* Fixed #6306: Projects plugin not reloading nested project configuration
27+
28+
mkdocs-material-9.4.10 (2023-11-19)
29+
30+
* Fixed #6356: Version selector can't be disabled via mike's configuration
31+
* Fixed #6281: Navigation not rendering due to Safari bug (9.4.2 regression)
32+
* Fixed #6261: Navigation expansion animates on first load (9.4.2 regression)
33+
34+
mkdocs-material-9.4.9 (2023-11-17)
35+
36+
* Fixed #6344: Long entries cutoff in table of contents
37+
* Fixed #6336: Custom template for glob archive not working with pagination
38+
* Fixed #6328: Blog plugin crashes for locales with dashes, e.g. pt-BR
39+
* Fixed #6327: Copy-to-clipboard button doesn't trim trailing line feed
40+
* Fixed #6302: Version strings not matched when using mike, only aliases
41+
* Fixed instant navigation progress indicator for gzipped content in Chrome
42+
* Fixed rendering bug on details marker rotation in Firefox
43+
144
mkdocs-material-9.4.8+insiders-4.43.0 (2023-11-05)
245

346
* Added support for GitLab committers (document contributors)

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,9 @@
5858
<a href="https://fastapi.tiangolo.com/" target=_blank><img
5959
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-fastapi.png" height="120"
6060
/></a>
61+
<a href="https://www.trendpop.com/" target=_blank><img
62+
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-trendpop.png" height="120"
63+
/></a>
6164
</p>
6265
<p>&nbsp;</p>
6366
<p align="center"><strong>Bronze sponsors</strong></p>

docs/changelog/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,32 @@
22

33
## Material for MkDocs
44

5+
### 9.4.12 <small>November 24, 2023</small> { id="9.4.12" }
6+
7+
- Improved blog plugin to generate Unicode-aware slugs by default
8+
- Fixed non-deterministic order of categories in blog plugin
9+
10+
### 9.4.11 <small>November 23, 2023</small> { id="9.4.11" }
11+
12+
- Fixed #6364: Search plugin crashing when enabling theme while serving
13+
- Fixed blog plugin crashing when disabling pagination
14+
15+
### 9.4.10 <small>November 19, 2023</small> { id="9.4.10" }
16+
17+
- Fixed #6356: Version selector can't be disabled via mike's configuration
18+
- Fixed #6281: Navigation not rendering due to Safari bug (9.4.2 regression)
19+
- Fixed #6261: Navigation expansion animates on first load (9.4.2 regression)
20+
21+
### 9.4.9 <small>November 17, 2023</small> { id="9.4.9" }
22+
23+
- Fixed #6344: Long entries cutoff in table of contents
24+
- Fixed #6336: Custom template for glob archive not working with pagination
25+
- Fixed #6328: Blog plugin crashes for locales with dashes, e.g. `pt-BR`
26+
- Fixed #6327: Copy-to-clipboard button doesn't trim trailing line feed
27+
- Fixed #6302: Version strings not matched when using mike, only aliases
28+
- Fixed instant navigation progress indicator for gzipped content in Chrome
29+
- Fixed rendering bug on details marker rotation in Firefox
30+
531
### 9.4.8 <small>November 5, 2023</small> { id="9.4.8" }
632

733
- Fixed invalid local address replacement when using instant loading

docs/conventions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ explicitly define them. The default value of the property is always included.
3333

3434
#### <!-- md:default computed --> – Default value is computed { #default data-toc-label="is computed" }
3535

36-
Some default values are not set to static values but computed form other values,
36+
Some default values are not set to static values but computed from other values,
3737
like the site language, repository provider, or other settings.
3838

3939
#### <!-- md:default none --> – Default value is empty { #default data-toc-label="is empty" }

docs/creating-your-site.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ theme:
6666
"yaml.customTags": [ // (1)!
6767
"!ENV scalar",
6868
"!ENV sequence",
69+
"!relative scalar",
6970
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
7071
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
7172
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"

docs/enterprise-support.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,32 @@
11
---
2-
template: redirect.html
3-
location: https://calendly.com/squidfunk/enterprise
42
status: new
53
---
4+
5+
# Enterprise Feedback
6+
7+
We highly value the insights of our enterprise users, and we're eager to hear
8+
from you. Your feedback is immensely valuable to us. If you're utilizing
9+
Material for MkDocs in an enterprise context and would like to share your
10+
experiences with us, we'd love to connect and discuss:
11+
12+
- What you are building with it
13+
- What aspects you like about it
14+
- What challenges you are facing
15+
- What could be improved
16+
17+
## Let's Connect
18+
19+
To schedule a convenient appointment, please reach out to us via email at
20+
[email protected] and provide us with the following details:
21+
22+
- Your company's name
23+
- How you are using Material for MkDocs
24+
- Any specific questions or topics you'd like to address
25+
26+
Once we have this information, we'll promptly get in touch with you to arrange
27+
a 30-minute call. Please note that this call is exclusively intended for
28+
enterprise users and is not meant for technical support. Instead, it's an
29+
opportunity for us to engage in a casual conversation to better understand your
30+
unique needs.
31+
32+
We look forward to our discussion!

docs/insiders/changelog/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
## Material for MkDocs Insiders
44

5+
### 4.45.0 <small>November 24, 2023</small> { id="4.45.0" }
6+
7+
- Added support for sorting blog categories by post count or custom function
8+
- Improved tags plugin to generate Unicode-aware slugs by default
9+
- Fixed non-deterministic order of multiple authors in blog plugin
10+
11+
### 4.44.0 <small>November 23, 2023</small> { id="4.44.0" }
12+
13+
- Added pagination settings for archive pages in blog plugin
14+
- Added pagination settings for category pages in blog plugin
15+
16+
### 4.43.1 <small>November 19, 2023</small> { id="4.43.1" }
17+
18+
- Added third-party theme support in projects plugin, improving editing
19+
- Fixed #6360: Projects plugin crashes when theme is not Material for MkDocs
20+
- Fixed #6306: Projects plugin not reloading nested project configuration
21+
522
### 4.43.0 <small>November 5, 2023</small> { id="4.43.0" }
623

724
- Added support for GitLab committers (document contributors)
Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
title: Community Experts Program
3+
status: new
4+
---
5+
6+
# Calling for Community Experts
7+
8+
Interested in joining the Material for MkDocs team as a Community Expert?
9+
We're on the lookout for individuals who are passionate about supporting our
10+
awesome community. In return for your valuable contributions, time, and
11+
insights, __you'll gain free access to the Insiders edition__.
12+
13+
## Why we need you
14+
15+
As our project and community continue to grow, so do the questions and needs of
16+
our users on our discussion board. Our discussion board is a vital part of our
17+
project, serving as a hub for our community to connect and a valuable knowledge
18+
base to complement our documentation.
19+
20+
We're eager to keeping it well-maintained, organized, easy to search and address
21+
all queries which is why we need extra hands to keep up with the demand.
22+
23+
That's why we're bulding a team of Community Experts!
24+
25+
## Your role
26+
27+
As a Community Expert, your role primarily involves active participation on
28+
our [discussion board], where we'd expect you to be:
29+
30+
- Answering discussions to help users with their questions
31+
- Providing guidance regarding implementations
32+
- Sharing insights into customizations and workarounds
33+
- Optimizing searchability by adjusting discussion titles with relevant keywords
34+
35+
## Your benefits
36+
37+
Here is a list of the benefits we offer to our Community Experts:
38+
39+
- __Free access to Material for MkDocs Insiders__ – Exclusive Access to all of
40+
our Material for MkDocs Insiders features for _non-commercial use_.[^1]
41+
42+
- __Close communication with the team__ – Stay connected with us through various
43+
channels, including calls and internal project management tools.
44+
45+
- __GitHub profile boost__ – Enhance your GitHub profile's visibility and
46+
credibility as your activity increases, earning you valuable badges that can
47+
enhance your credibility.
48+
49+
[^1]:
50+
Access to Insiders is granted to your primary account, i.e., the account
51+
with which you're contributing to the project. It cannot be transferred to
52+
another account. Additionally, it cannot be used for commercial purposes.
53+
54+
## Your knowledge & skills
55+
56+
To be a successful Community Expert, your skills should include the following:
57+
58+
- __Material and MkDocs allrounder__ – You have an understanding of Material
59+
for MkDocs and the MkDocs ecosystem, including many of its extensions and
60+
plugins.
61+
62+
- __Great communicator__ – You enjoy helping others in a productive,
63+
constructive and friendly manner and use inclusive and welcoming language.
64+
65+
- __Independent worker__ – You are self-motivated, stay up-to-date with
66+
project developments, regularly check the discussion board, and respond to
67+
notifications in reasonable time.
68+
69+
[discussion board]: https://github.com/squidfunk/mkdocs-material/discussions
70+
[documentation]: https://squidfunk.github.io/mkdocs-material/
71+
[contribution guides]: ../contributing/index.md
72+
73+
## Your time commitment
74+
75+
We don't require a fixed number of hours each week; instead, we ask for a
76+
minimum of __five answered discussions per month[^2]__, which amounts to
77+
slightly more than one per week. Your active interaction within the community is
78+
highly valued.
79+
80+
To do this effectively, it's best to regularly check the discussion board to see
81+
where you can offer help. The time you invest may vary depending on the
82+
complexity of the topics and questions.
83+
84+
Upon joining, you'll receive access to the Insiders' edition for as long as you
85+
continue to assist us. Access will be renewed every three months, allowing you
86+
the flexibility to continue your contributions or take a break as needed.
87+
88+
[^2]:
89+
An answered discussion is a collaborative interaction where knowledge and
90+
expertise are shared, resulting in resolutions or clarifications that benefit
91+
the user and our entire community. In essence, it embodies the spirit of
92+
cooperation and support within our community, highlighting the power of
93+
collective wisdom and the willingness to assist and uplift one another.
94+
95+
## Ready to get started?
96+
97+
Since we have a limited number of seats for these roles[^3], we would like to
98+
get to know you before you become one of our Community Experts. Here's how to
99+
get started:
100+
101+
[^3]:
102+
Please note that we're currently limiting the number of seats on the
103+
Community Experts program to three. We will update this page when we'll
104+
expand the team, which is when we'll be accepting new applications.
105+
106+
### Step 1: Get in touch
107+
108+
Send us an email introducing yourself, sharing a bit about your background, and
109+
include a link to your GitHub profile. Additionally, provide links to three
110+
previous discussions you've answered on the discussion board, where you've
111+
assisted another community member.
112+
113+
Please use the following email template to reach out to us at
114+
115+
116+
```
117+
Subject: Community Expert
118+
119+
Intro: Tell us a bit about yourself.
120+
- Name:
121+
- Background:
122+
- Profession:
123+
- GitHub profile:
124+
125+
Answered discussions
126+
- Link 1:
127+
- Link 2:
128+
- Link 3:
129+
```
130+
131+
### Step 2: Evaluation
132+
133+
After receiving and reviewing your application, we will get in touch with you
134+
to discuss everything you need to know to get started. If you get selected, we
135+
will set you up as a collaborator and provide you immediate access to the
136+
Insiders edition for three months.
137+
138+
### Step 3: Dive in
139+
140+
Let's get started! You can actively begin participating in five discussions per
141+
month. We trust you to take the lead, and we won't do strict monitoring. Simply
142+
ensure that you are consistently listed on the _Most Helpful_ list, located on
143+
the discussion board's left side, under the categories.
144+
---
145+
146+
__Ready to join us?__
147+
148+
Sounds good? Let's give it a try!

0 commit comments

Comments
 (0)