mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-12 01:50:52 +01:00
Updated Insiders documentation
This commit is contained in:
parent
ca4d7f3db7
commit
abea8c8187
@ -1,3 +1,8 @@
|
||||
mkdocs-material-6.2.5+insiders-1.16.0 (2021-01-17)
|
||||
|
||||
* Added latest release to repository info (GitHub)
|
||||
* Slight facelift of repsitory info (lighter fonts, spacing and icons)
|
||||
|
||||
mkdocs-material-6.2.5 (2021-01-17)
|
||||
|
||||
* Fixed syntax error in Swedish translations
|
||||
|
BIN
docs/assets/screenshots/repository.png
Normal file
BIN
docs/assets/screenshots/repository.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 344 KiB |
@ -6,6 +6,11 @@ template: overrides/main.html
|
||||
|
||||
## Material for MkDocs Insiders
|
||||
|
||||
### 1.16.0 <small>_ January 7, 2021</small>
|
||||
|
||||
- Added latest release to repository info (GitHub)
|
||||
- Slight facelift of repsitory info (lighter fonts, spacing and icons)
|
||||
|
||||
### 1.15.0 <small>_ January 2, 2021</small>
|
||||
|
||||
- Added support for native Mermaid.js integration
|
||||
|
@ -100,16 +100,17 @@ The following features are currently exclusively available to sponsors:
|
||||
|
||||
<div class="tx-columns" markdown="1">
|
||||
|
||||
- [x] [Color palette toggle][15]
|
||||
- [x] [Latest release tag :material-new-box:][15]
|
||||
- [x] [Color palette toggle][16]
|
||||
- [x] [Versioning][14]
|
||||
- [x] [Site language selection][13]
|
||||
- [x] [Sticky navigation tabs][19]
|
||||
- [x] [Native Mermaid.js integration][21]
|
||||
- [x] [Sticky navigation tabs][20]
|
||||
- [x] [Native Mermaid.js integration][22]
|
||||
- [x] [Admonition inline blocks][12]
|
||||
- [x] [Search suggestions][16]
|
||||
- [x] [Search highlighting][17]
|
||||
- [x] [Search sharing][18]
|
||||
- [x] [Remove generator notice][20]
|
||||
- [x] [Search suggestions][17]
|
||||
- [x] [Search highlighting][18]
|
||||
- [x] [Search sharing][19]
|
||||
- [x] [Remove generator notice][21]
|
||||
|
||||
</div>
|
||||
|
||||
@ -139,39 +140,41 @@ the public for general availability.
|
||||
|
||||
#### $ 2,000 – Black Pearl
|
||||
|
||||
- [x] [Color palette toggle][15]
|
||||
- [x] [Latest release tag][15]
|
||||
- [x] [Color palette toggle][16]
|
||||
- [ ] Code block palette toggle
|
||||
|
||||
[15]: setup/changing-the-colors.md#color-palette-toggle
|
||||
[15]: setup/adding-a-git-repository.md#latest-release
|
||||
[16]: setup/changing-the-colors.md#color-palette-toggle
|
||||
|
||||
#### $ 2,500 – Biquinho Vermelho
|
||||
|
||||
- [x] [Search suggestions][16]
|
||||
- [x] [Search highlighting][17]
|
||||
- [x] [Search sharing][18]
|
||||
- [x] [Search suggestions][17]
|
||||
- [x] [Search highlighting][18]
|
||||
- [x] [Search sharing][19]
|
||||
|
||||
[16]: setup/setting-up-site-search.md#search-suggestions
|
||||
[17]: setup/setting-up-site-search.md#search-highlighting
|
||||
[18]: setup/setting-up-site-search.md#search-sharing
|
||||
[17]: setup/setting-up-site-search.md#search-suggestions
|
||||
[18]: setup/setting-up-site-search.md#search-highlighting
|
||||
[19]: setup/setting-up-site-search.md#search-sharing
|
||||
|
||||
#### $ 3,000 – Caribbean Red
|
||||
|
||||
- [x] [Sticky navigation tabs][19]
|
||||
- [x] [Remove generator notice][20]
|
||||
- [x] [Sticky navigation tabs][20]
|
||||
- [x] [Remove generator notice][21]
|
||||
- [ ] Support for index pages
|
||||
|
||||
[19]: setup/setting-up-navigation.md#sticky-navigation-tabs
|
||||
[20]: setup/setting-up-the-footer.md#remove-generator
|
||||
[20]: setup/setting-up-navigation.md#sticky-navigation-tabs
|
||||
[21]: setup/setting-up-the-footer.md#remove-generator
|
||||
|
||||
#### $ 5,000 - Aji Panca
|
||||
|
||||
- [x] [Native Mermaid.js integration][21]
|
||||
- [x] [Native Mermaid.js integration][22]
|
||||
|
||||
[21]: reference/diagrams.md
|
||||
[22]: reference/diagrams.md
|
||||
|
||||
#### Future
|
||||
|
||||
- [ ] [Material for MkDocs Live Edit][22]
|
||||
- [ ] [Material for MkDocs Live Edit][23]
|
||||
- [ ] Improved search result summaries
|
||||
- [ ] List of last searches
|
||||
- [ ] Table of contents follows active anchor
|
||||
@ -181,7 +184,7 @@ the public for general availability.
|
||||
- [ ] New layouts and styles (e.g. vertical)
|
||||
- [ ] ... and much more ...
|
||||
|
||||
[22]: https://twitter.com/squidfunk/status/1338252230265360391
|
||||
[23]: https://twitter.com/squidfunk/status/1338252230265360391
|
||||
|
||||
### Goals completed
|
||||
|
||||
@ -217,10 +220,10 @@ implemented behind feature flags; all configuration changes are
|
||||
backward-compatible. This means that your users will be able to build the
|
||||
documentation locally with Material for MkDocs and when they push their changes,
|
||||
it can be built with Insiders (e.g. as part of GitHub Actions). Thus, it's
|
||||
recommended to [install Insiders][23] only in CI, as you don't want to expose
|
||||
recommended to [install Insiders][24] only in CI, as you don't want to expose
|
||||
your `GH_TOKEN` to users.
|
||||
|
||||
[23]: publishing-your-site.md#github-pages
|
||||
[24]: publishing-your-site.md#github-pages
|
||||
|
||||
### Terms
|
||||
|
||||
@ -229,7 +232,7 @@ commercial project. Can we use Insiders under the same terms and conditions?_
|
||||
|
||||
Yes. Whether you're an individual or a company, you may use _Material for MkDocs
|
||||
Insiders_ precisely under the same terms as Material for MkDocs, which are given
|
||||
by the [MIT license][24]. However, we kindly ask you to respect the following
|
||||
by the [MIT license][25]. However, we kindly ask you to respect the following
|
||||
guidelines:
|
||||
|
||||
- Please __don't distribute the source code__ of Insiders. You may freely use
|
||||
@ -240,7 +243,7 @@ guidelines:
|
||||
- If you cancel your subscription, you're removed as a collaborator and will
|
||||
miss out on future updates of Insiders. However, you may __use the latest
|
||||
version__ that's available to you __as long as you like__. Just remember that
|
||||
[GitHub deletes private forks][25].
|
||||
[GitHub deletes private forks][26].
|
||||
|
||||
[24]: license.md
|
||||
[25]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
|
||||
[25]: license.md
|
||||
[26]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
|
||||
|
@ -72,14 +72,39 @@ 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:{: .tx-heart } Insiders only][5]{: .tx-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.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][5] · :octicons-milestone-24: Default:
|
||||
[:octicons-file-code-24: Source][8] · :octicons-milestone-24: Default:
|
||||
_automatically set_
|
||||
|
||||
If the repository URL points to a [GitHub][6], [GitLab][7] or [Bitbucket][8]
|
||||
If the repository URL points to a [GitHub][9], [GitLab][10] or [Bitbucket][11]
|
||||
repository, an _edit button_ is displayed at the top of each document. This
|
||||
behavior can be changed by setting [`edit_uri`][9] in `mkdocs.yml`:
|
||||
behavior can be changed by setting [`edit_uri`][12] in `mkdocs.yml`:
|
||||
|
||||
=== "Customize edit path"
|
||||
|
||||
@ -93,18 +118,18 @@ behavior can be changed by setting [`edit_uri`][9] in `mkdocs.yml`:
|
||||
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
|
||||
[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
|
||||
|
||||
### Revision date
|
||||
|
||||
[:octicons-file-code-24: Source][10] ·
|
||||
[:octicons-cpu-24: Plugin][11]
|
||||
[:octicons-file-code-24: Source][13] ·
|
||||
[:octicons-cpu-24: Plugin][14]
|
||||
|
||||
The [git-revision-date][11] plugin adds support for displaying the date a
|
||||
The [git-revision-date][13] plugin adds support for displaying the date a
|
||||
document was _last updated_ at the bottom of each page. It can be installed
|
||||
with `pip`:
|
||||
|
||||
@ -137,15 +162,15 @@ _Material for MkDocs doesn't provide official support for the other options of
|
||||
this plugin, so they may be supported but can also yield weird results. Use
|
||||
them at your own risk._
|
||||
|
||||
[10]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/source-date.html
|
||||
[11]: https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin
|
||||
[13]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/source-date.html
|
||||
[14]: https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin
|
||||
|
||||
### Revision date, localized
|
||||
|
||||
[:octicons-file-code-24: Source][10] ·
|
||||
[:octicons-cpu-24: Plugin][12]
|
||||
[:octicons-file-code-24: Source][13] ·
|
||||
[:octicons-cpu-24: Plugin][15]
|
||||
|
||||
Similarly, the [git-revision-date-localized][12] plugin adds support for adding
|
||||
Similarly, the [git-revision-date-localized][15] plugin adds support for adding
|
||||
a localized _last updated_ date at the bottom of each page. It can be installed
|
||||
with `pip`:
|
||||
|
||||
@ -190,4 +215,4 @@ _Material for MkDocs doesn't provide official support for the other options of
|
||||
this plugin, so they may be supported but can also yield weird results. Use
|
||||
them at your own risk._
|
||||
|
||||
[12]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
|
||||
[15]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
|
||||
|
Loading…
Reference in New Issue
Block a user