Skip to content

Commit

Permalink
Merge of Insiders features tied to 'Aji Panca' funding goal
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Feb 17, 2022
1 parent 9013701 commit b5e71df
Show file tree
Hide file tree
Showing 57 changed files with 1,670 additions and 13,500 deletions.
1 change: 1 addition & 0 deletions .stylelintignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ material
src/**/*.html

# Prevent stylelint from constantly complaining
*.css
*.ts
3 changes: 1 addition & 2 deletions docs/blog/2021/the-past-present-and-future.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ are still exclusively available to sponsors as part of [Insiders]:
- [Navigation icons]
- [Remove generator notice]
- [Rich search previews]
- [Stay on page when switching versions]
- Stay on page when switching versions
- [Search highlighting]
- [Search sharing]
- [Search suggestions]
Expand Down Expand Up @@ -202,7 +202,6 @@ __55__ times, `mkdocs-material-insiders` was shipped __72__ times.
[Section index pages]: ../../setup/setting-up-navigation.md#section-index-pages
[Site language selection]: ../../setup/changing-the-language.md#site-language-selector
[Social cards]: ../../setup/setting-up-social-cards.md
[Stay on page when switching versions]: ../../setup/setting-up-versioning.md#stay-on-page
[Sticky navigation tabs]: ../../setup/setting-up-navigation.md#sticky-navigation-tabs
[Tags with search integration]: ../../setup/setting-up-tags.md
[Tokenizer with lookahead]: search-better-faster-smaller.md#tokenizer-lookahead
Expand Down
20 changes: 9 additions & 11 deletions docs/insiders/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,6 @@ The following features are solely available via Material for MkDocs Insiders:
- [x] [Linking content tabs]
- [x] [Boosting pages in search]
- [x] [Tags with search integration]
- [x] [Stay on page when switching versions]
- [x] [Custom admonition icons]
- [x] [Mermaid.js integration]

Expand All @@ -200,16 +199,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is
: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
are released for general availability.

#### $ 5,000 – Aji Panca

- [x] [Mermaid.js integration]
- [x] [Stay on page when switching versions]
- [x] [Tags with search integration]

[Mermaid.js integration]: ../reference/diagrams.md
[Stay on page when switching versions]: ../setup/setting-up-versioning.md#stay-on-page
[Tags with search integration]: ../setup/setting-up-tags.md

#### $ 6,000 – Trinidad Scorpion

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

#### $ 5,000 – Aji Panca

- [x] [Mermaid.js integration]
- [x] Stay on page when switching versions
- [x] [Tags with search integration]

[Mermaid.js integration]: ../reference/diagrams.md
[Tags with search integration]: ../setup/setting-up-tags.md

#### $ 4,000 – Ghost Pepper

- [x] [Anchor tracking]
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/diagrams.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ popular and flexible solution for drawing diagrams.

## Configuration

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

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

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

Expand Down
5 changes: 2 additions & 3 deletions docs/setup/setting-up-tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ can help to discover relevant information faster.

### Built-in tags

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

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

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

## Usage
Expand Down
27 changes: 0 additions & 27 deletions docs/setup/setting-up-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,33 +108,6 @@ Make sure that this matches the [default version].
[Version warning preview]: ../assets/screenshots/version-warning.png
[default version]: #setting-a-default-version

### Stay on page

[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-2.6.0][Insiders]

Insiders improves the user experience when switching between versions: if
version A and B contain a page with the same path name, the user will stay on
the current page:

=== "New behavior"

```
docs.example.com/0.1/ -> docs.example.com/0.2/
docs.example.com/0.1/foo/ -> docs.example.com/0.2/foo/
docs.example.com/0.1/bar/ -> docs.example.com/0.2/bar/
```

=== "Old behavior"

```
docs.example.com/0.1/ -> docs.example.com/0.2/
docs.example.com/0.1/foo/ -> docs.example.com/0.2/
docs.example.com/0.1/bar/ -> docs.example.com/0.2/
```

[Insiders]: ../insiders/index.md

## Usage

While this section outlines the basic workflow for publishing new versions,
Expand Down
29 changes: 0 additions & 29 deletions material/assets/javascripts/bundle.5a9542cf.min.js

This file was deleted.

8 changes: 0 additions & 8 deletions material/assets/javascripts/bundle.5a9542cf.min.js.map

This file was deleted.

29 changes: 29 additions & 0 deletions material/assets/javascripts/bundle.8aa65030.min.js

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions material/assets/javascripts/bundle.8aa65030.min.js.map

Large diffs are not rendered by default.

Loading

0 comments on commit b5e71df

Please sign in to comment.