Skip to content

Commit

Permalink
Prepare 7.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Mar 29, 2021
1 parent ca3da9e commit 13b584b
Show file tree
Hide file tree
Showing 10 changed files with 91 additions and 121 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
mkdocs-material-7.1.0 (2021-03-29)

* Added support for color palette toggle
* Added support for back-to-top button
* Added latest release to repository info (GitHub)
* Slight facelift of repository info (lighter fonts, spacing and icons)

mkdocs-material-7.0.7+insiders-2.5.0 (2021-03-28)

* Added support for version warning
Expand Down
Binary file removed docs/assets/screenshots/repository.png
Binary file not shown.
7 changes: 7 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ template: overrides/main.html

## Material for MkDocs

### 7.1.0 <small>_ March 29, 2021</small>

- Added support for back-to-top button
- Added support for color palette toggle
- Added latest release to repository info (GitHub)
- Slight facelift of repository info (lighter fonts, spacing and icons)

### 7.0.7 <small>_ March 28, 2021</small>

- Updated Hungarian translations
Expand Down
48 changes: 21 additions & 27 deletions docs/insiders/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,8 @@ The following features are currently exclusively available to sponsors:
- [x] [Version warning :material-new-box:][26]
- [x] [Custom admonition icons :material-new-box:][28]
- [x] [Code block annotations :material-new-box:][25]
- [x] [Back-to-top button][17]
- [x] [Anchor tracking ][24]
- [x] [Section index pages][22]
- [x] [Latest release tag][15]
- [x] [Color palette toggle][16]
- [x] [Sticky navigation tabs][21]
- [x] [Mermaid.js integration][27]
- [x] [Search suggestions][18]
Expand All @@ -142,18 +139,6 @@ Following is a list of funding goals. When a funding goal is hit, the features
that are tied to it are merged back into Material for MkDocs and released to
the public for general availability.

#### $ 2,000 – Black Pearl

_Goal reached :tada: – features will be merged in the next days!_

- [x] [Latest release tag][15]
- [x] [Color palette toggle][16]
- [x] [Back-to-top button][17]

[15]: ../setup/adding-a-git-repository.md#latest-release
[16]: ../setup/changing-the-colors.md#color-palette-toggle
[17]: ../setup/setting-up-navigation.md#back-to-top-button

#### $ 2,500 – Biquinho Vermelho

- [x] [Search suggestions][18]
Expand Down Expand Up @@ -222,11 +207,24 @@ _Goal reached :tada: – features will be merged in the next days!_

### Goals completed

#### $ 500Madame Jeanette
#### $ 2,000Black Pearl

- [x] Improved search result grouping
- [x] Improved search result relevance and scoring
- [x] Missing query terms in search results
- [x] Latest release tag
- [x] [Color palette toggle][16]
- [x] [Back-to-top button][17]

[16]: ../setup/changing-the-colors.md#color-palette-toggle
[17]: ../setup/setting-up-navigation.md#back-to-top-button

#### $ 1,500 – Bhut Jolokia

- [x] [Admonition inline blocks][12]
- [x] [Site language selection][13]
- [x] [Versioning][14]

[12]: ../reference/admonitions.md#inline-blocks
[13]: ../setup/changing-the-language.md#site-language-selector
[14]: ../setup/setting-up-versioning.md#versioning

#### $ 1,000 – Prairie Fire

Expand All @@ -242,15 +240,11 @@ _Goal reached :tada: – features will be merged in the next days!_
[10]: ../setup/setting-up-navigation.md#navigation-integration
[11]: ../setup/setting-up-the-header.md#automatic-hiding

#### $ 1,500 – Bhut Jolokia

- [x] [Admonition inline blocks][12]
- [x] [Site language selection][13]
- [x] [Versioning][14]
#### $ 500 – Madame Jeanette

[12]: ../reference/admonitions.md#inline-blocks
[13]: ../setup/changing-the-language.md#site-language-selector
[14]: ../setup/setting-up-versioning.md#versioning
- [x] Improved search result grouping
- [x] Improved search result relevance and scoring
- [x] Missing query terms in search results

## Frequently asked questions

Expand Down
59 changes: 17 additions & 42 deletions docs/setup/adding-a-git-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,39 +72,14 @@ Some popular choices:

[4]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons

### Latest release

[:octicons-file-code-24: Source][5] ·
[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][5]{ .mdx-insiders }

The visual appearance of the repository link has been improved as part of
[Insiders][5], and will now automatically include the latest release tag which
is not marked as a draft or pre-release:

<figure markdown="1">

[![Search suggestions][6]][6]

<figcaption markdown="1">

A demo is worth a thousand words — check it out at
[squidfunk.github.io/mkdocs-material-insiders][7]

</figcaption>
</figure>

[5]: ../insiders/index.md
[6]: ../assets/screenshots/repository.png
[7]: https://squidfunk.github.io/mkdocs-material-insiders/setup/adding-a-git-repository/

### Edit button

[:octicons-file-code-24: Source][8] · :octicons-milestone-24: Default:
[:octicons-file-code-24: Source][5] · :octicons-milestone-24: Default:
_automatically set_

If the repository URL points to a [GitHub][9], [GitLab][10] or [Bitbucket][11]
If the repository URL points to a [GitHub][6], [GitLab][7] or [Bitbucket][8]
repository, an _edit button_ is displayed at the top of each document. This
behavior can be changed by setting [`edit_uri`][12] in `mkdocs.yml`:
behavior can be changed by setting [`edit_uri`][9] in `mkdocs.yml`:

=== "Customize edit path"

Expand All @@ -118,18 +93,18 @@ behavior can be changed by setting [`edit_uri`][12] in `mkdocs.yml`:
edit_uri: ""
```

[8]: https://github.com/squidfunk/mkdocs-material/blob/master/src/base.html
[9]: https://github.com/
[10]: https://about.gitlab.com/
[11]: https://bitbucket.org/
[12]: https://www.mkdocs.org/user-guide/configuration/#edit_uri
[5]: https://github.com/squidfunk/mkdocs-material/blob/master/src/base.html
[6]: https://github.com/
[7]: https://about.gitlab.com/
[8]: https://bitbucket.org/
[9]: https://www.mkdocs.org/user-guide/configuration/#edit_uri

### Revision date

[:octicons-file-code-24: Source][13] ·
[:octicons-cpu-24: Plugin][14]
[:octicons-file-code-24: Source][10] ·
[:octicons-cpu-24: Plugin][11]

The [git-revision-date][13] plugin adds support for displaying the date a
The [git-revision-date][10] plugin adds support for displaying the date a
document was _last updated_ at the bottom of each page. It can be installed
with `pip`:

Expand Down Expand Up @@ -162,15 +137,15 @@ _Material for MkDocs doesn't provide official support for the other options of
this plugin, so they may be supported but might yield unexpected results.
Use them at your own risk._

[13]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/source-date.html
[14]: https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin
[10]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/source-date.html
[11]: https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin

### Revision date, localized

[:octicons-file-code-24: Source][13] ·
[:octicons-cpu-24: Plugin][15]
[:octicons-file-code-24: Source][10] ·
[:octicons-cpu-24: Plugin][12]

Similarly, the [git-revision-date-localized][15] plugin adds support for adding
Similarly, the [git-revision-date-localized][12] plugin adds support for adding
a localized _last updated_ date at the bottom of each page. It can be installed
with `pip`:

Expand Down Expand Up @@ -215,4 +190,4 @@ _Material for MkDocs doesn't provide official support for the other options of
this plugin, so they may be supported but might yield unexpected results.
Use them at your own risk._

[15]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
[12]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
15 changes: 1 addition & 14 deletions docs/setup/changing-the-colors.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,6 @@ _Click on a tile to change the color scheme_:
})
</script>
The _color scheme_ can also be set based on _user preference_, which makes use
of the `prefers-color-scheme` media query, by setting the value in `mkdocs.yml`
to `preference`:

``` yaml
theme:
palette:
scheme: preference
```

[3]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/palette/_scheme.scss
#### Primary color
Expand Down Expand Up @@ -183,10 +173,7 @@ _Click on a tile to change the accent color_:

### Color palette toggle

[:octicons-file-code-24: Source][6] ·
[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][6]{ .mdx-insiders }

[Insiders][6] can easily add multiple color palettes, including a [scheme][8],
It's also possible to add multiple color palettes, including a [scheme][8],
[primary][9] and [accent][10] color each, and let the user choose. A color
palette toggle can be added via `mkdocs.yml`:

Expand Down
Loading

0 comments on commit 13b584b

Please sign in to comment.