Skip to content

Commit b5e71df

Browse files
committed
Merge of Insiders features tied to 'Aji Panca' funding goal
1 parent 9013701 commit b5e71df

Some content is hidden

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

57 files changed

+1670
-13500
lines changed

.stylelintignore

+1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,5 @@ material
2424
src/**/*.html
2525

2626
# Prevent stylelint from constantly complaining
27+
*.css
2728
*.ts

docs/blog/2021/the-past-present-and-future.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ are still exclusively available to sponsors as part of [Insiders]:
150150
- [Navigation icons]
151151
- [Remove generator notice]
152152
- [Rich search previews]
153-
- [Stay on page when switching versions]
153+
- Stay on page when switching versions
154154
- [Search highlighting]
155155
- [Search sharing]
156156
- [Search suggestions]
@@ -202,7 +202,6 @@ __55__ times, `mkdocs-material-insiders` was shipped __72__ times.
202202
[Section index pages]: ../../setup/setting-up-navigation.md#section-index-pages
203203
[Site language selection]: ../../setup/changing-the-language.md#site-language-selector
204204
[Social cards]: ../../setup/setting-up-social-cards.md
205-
[Stay on page when switching versions]: ../../setup/setting-up-versioning.md#stay-on-page
206205
[Sticky navigation tabs]: ../../setup/setting-up-navigation.md#sticky-navigation-tabs
207206
[Tags with search integration]: ../../setup/setting-up-tags.md
208207
[Tokenizer with lookahead]: search-better-faster-smaller.md#tokenizer-lookahead

docs/insiders/index.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,6 @@ The following features are solely available via Material for MkDocs Insiders:
184184
- [x] [Linking content tabs]
185185
- [x] [Boosting pages in search]
186186
- [x] [Tags with search integration]
187-
- [x] [Stay on page when switching versions]
188187
- [x] [Custom admonition icons]
189188
- [x] [Mermaid.js integration]
190189

@@ -200,16 +199,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is
200199
:octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features
201200
are released for general availability.
202201

203-
#### $ 5,000 – Aji Panca
204-
205-
- [x] [Mermaid.js integration]
206-
- [x] [Stay on page when switching versions]
207-
- [x] [Tags with search integration]
208-
209-
[Mermaid.js integration]: ../reference/diagrams.md
210-
[Stay on page when switching versions]: ../setup/setting-up-versioning.md#stay-on-page
211-
[Tags with search integration]: ../setup/setting-up-tags.md
212-
213202
#### $ 6,000 – Trinidad Scorpion
214203

215204
- [x] [Boosting pages in search]
@@ -277,6 +266,15 @@ This section lists all funding goals that were previously completed, which means
277266
that those features were part of Insiders, but are now generally available and
278267
can be used by all users.
279268

269+
#### $ 5,000 – Aji Panca
270+
271+
- [x] [Mermaid.js integration]
272+
- [x] Stay on page when switching versions
273+
- [x] [Tags with search integration]
274+
275+
[Mermaid.js integration]: ../reference/diagrams.md
276+
[Tags with search integration]: ../setup/setting-up-tags.md
277+
280278
#### $ 4,000 – Ghost Pepper
281279

282280
- [x] [Anchor tracking]

docs/reference/diagrams.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ popular and flexible solution for drawing diagrams.
1414

1515
## Configuration
1616

17-
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
18-
[:octicons-tag-24: insiders-1.15.0][Insiders] ·
17+
[:octicons-tag-24: 8.2.0][Diagrams support] ·
1918
:octicons-beaker-24: Experimental
2019

2120
This configuration enables native support for [Mermaid.js] diagrams. Material
@@ -44,7 +43,7 @@ No further configuration is necessary. Advantages over a custom integration:
4443
sequence diagrams, class diagams, state diagrams and entity relationship
4544
diagrams.
4645

47-
[Insiders]: ../insiders/index.md
46+
[Diagrams support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.2.0
4847
[instant loading]: ../setup/setting-up-navigation.md#instant-loading
4948
[additional style sheets]: ../customization.md#additional-css
5049

docs/setup/setting-up-tags.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ can help to discover relevant information faster.
1313

1414
### Built-in tags
1515

16-
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
17-
[:octicons-tag-24: insiders-2.7.0][Insiders] ·
16+
[:octicons-tag-24: 8.2.0][tags support] ·
1817
:octicons-cpu-24: Plugin ·
1918
:octicons-beaker-24: Experimental
2019

@@ -47,7 +46,7 @@ The following configuration options are available:
4746
option is not specified, tags are still rendered and searchable,
4847
but without a tags index.
4948

50-
[Insiders]: ../insiders/index.md
49+
[tags support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.2.0
5150
[adding a tags index]: #adding-a-tags-index
5251

5352
## Usage

docs/setup/setting-up-versioning.md

-27
Original file line numberDiff line numberDiff line change
@@ -108,33 +108,6 @@ Make sure that this matches the [default version].
108108
[Version warning preview]: ../assets/screenshots/version-warning.png
109109
[default version]: #setting-a-default-version
110110

111-
### Stay on page
112-
113-
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
114-
[:octicons-tag-24: insiders-2.6.0][Insiders]
115-
116-
Insiders improves the user experience when switching between versions: if
117-
version A and B contain a page with the same path name, the user will stay on
118-
the current page:
119-
120-
=== "New behavior"
121-
122-
```
123-
docs.example.com/0.1/ -> docs.example.com/0.2/
124-
docs.example.com/0.1/foo/ -> docs.example.com/0.2/foo/
125-
docs.example.com/0.1/bar/ -> docs.example.com/0.2/bar/
126-
```
127-
128-
=== "Old behavior"
129-
130-
```
131-
docs.example.com/0.1/ -> docs.example.com/0.2/
132-
docs.example.com/0.1/foo/ -> docs.example.com/0.2/
133-
docs.example.com/0.1/bar/ -> docs.example.com/0.2/
134-
```
135-
136-
[Insiders]: ../insiders/index.md
137-
138111
## Usage
139112

140113
While this section outlines the basic workflow for publishing new versions,

material/assets/javascripts/bundle.5a9542cf.min.js

-29
This file was deleted.

material/assets/javascripts/bundle.5a9542cf.min.js.map

-8
This file was deleted.

material/assets/javascripts/bundle.8aa65030.min.js

+29
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

material/assets/javascripts/bundle.8aa65030.min.js.map

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)