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
6429f71d3b
commit
cab5693713
@ -61,28 +61,30 @@ for MkDocs Insiders. You can click on each feature to learn more about it:
|
||||
|
||||
- [x] [Remove _Made with Material for MkDocs_ from footer][11]
|
||||
- [x] [Support for user-toggleable themes (light/dark mode switch)][12]
|
||||
- [x] [Search suggestions help to save keystrokes][13]
|
||||
- [x] [Highlighting of matched search terms in content area][14]
|
||||
- [x] [Support for multiple versions of documents][13]
|
||||
- [x] [Search suggestions help to save keystrokes][14]
|
||||
- [x] [Highlighting of matched search terms in content area][15]
|
||||
- [x] Search goes to first result on ++enter++ (I'm feeling lucky)
|
||||
- [x] [Navigation can always be expanded via configuration][15]
|
||||
- [x] [Header can be automatically hidden on scrolling][16]
|
||||
- [x] [Table of contents can be automatically hidden when empty][17]
|
||||
- [x] [Navigation can always be expanded via configuration][16]
|
||||
- [x] [Header can be automatically hidden on scrolling][17]
|
||||
- [x] [Table of contents can be automatically hidden when empty][18]
|
||||
|
||||
[11]: setup/setting-up-the-footer.md#remove-generator
|
||||
[12]: setup/changing-the-colors.md#color-palette-toggle
|
||||
[13]: setup/setting-up-site-search.md#search-suggestions
|
||||
[14]: setup/setting-up-site-search.md#search-highlighting
|
||||
[15]: setup/setting-up-navigation.md#navigation-expansion
|
||||
[16]: setup/setting-up-the-header.md#automatic-hiding
|
||||
[17]: setup/setting-up-navigation.md#automatic-hiding
|
||||
[13]: setup/setting-up-versioning.md#versioning
|
||||
[14]: setup/setting-up-site-search.md#search-suggestions
|
||||
[15]: setup/setting-up-site-search.md#search-highlighting
|
||||
[16]: setup/setting-up-navigation.md#navigation-expansion
|
||||
[17]: setup/setting-up-the-header.md#automatic-hiding
|
||||
[18]: setup/setting-up-navigation.md#automatic-hiding
|
||||
|
||||
## Roadmap
|
||||
|
||||
The following list of funding goals – named after varieties of chili peppers
|
||||
[I'm growing on my balcony][18] – shows which features are already available
|
||||
[I'm growing on my balcony][19] – shows which features are already available
|
||||
in Material for MkDocs Insiders.
|
||||
|
||||
[18]: https://www.instagram.com/squidfunk/
|
||||
[19]: https://www.instagram.com/squidfunk/
|
||||
|
||||
### Madame Jeanette
|
||||
|
||||
@ -98,12 +100,10 @@ in Material for MkDocs Insiders.
|
||||
[:octicons-flame-24: Funding goal: __$1,000__][6] ·
|
||||
:octicons-lock-24: Status: _exclusive_
|
||||
|
||||
- [x] [Navigation can always be expanded via configuration][15]
|
||||
- [x] [Header can be automatically hidden on scrolling][16]
|
||||
- [x] [Table of contents can be automatically hidden when empty][17]
|
||||
- [x] [Navigation can always be expanded via configuration][16]
|
||||
- [x] [Header can be automatically hidden on scrolling][17]
|
||||
- [x] [Table of contents can be automatically hidden when empty][18]
|
||||
- [ ] Table of contents can be moved into navigation for more space
|
||||
- [ ] Table of contents shows which sections have search results
|
||||
- [ ] Table of contents auto-collapses and expands only the active section
|
||||
- [ ] Better support for wide screens, i.e. more horizontal space
|
||||
|
||||
### Bhut Jolokia
|
||||
@ -111,9 +111,8 @@ in Material for MkDocs Insiders.
|
||||
[:octicons-flame-24: Funding goal: __$1,500__][6] ·
|
||||
:octicons-lock-24: Status: _exclusive_
|
||||
|
||||
- [x] [Support for multiple versions of documents][13]
|
||||
- [ ] Support for multiple languages of documents
|
||||
- [ ] Support for multiple versions of documents
|
||||
- [ ] Support for one or more management plugins
|
||||
|
||||
### Black Pearl
|
||||
|
||||
@ -122,15 +121,17 @@ in Material for MkDocs Insiders.
|
||||
|
||||
- [x] [Support for user-toggleable themes (light/dark mode switch)][12]
|
||||
- [ ] Support for user-toggleable code-block styles (light/dark mode switch)
|
||||
- [ ] Table of contents auto-collapses and expands only the active section
|
||||
|
||||
### Biquinho Vermelho
|
||||
|
||||
[:octicons-flame-24: Funding goal: __$2,500__][6] ·
|
||||
:octicons-lock-24: Status: _exclusive_
|
||||
|
||||
- [x] [Search suggestions help to save keystrokes][13]
|
||||
- [x] [Highlighting of matched search terms in content area][14]
|
||||
- [x] [Search suggestions help to save keystrokes][14]
|
||||
- [x] [Highlighting of matched search terms in content area][15]
|
||||
- [x] Search goes to first result on ++enter++ (I'm feeling lucky)
|
||||
- [ ] Table of contents shows which sections have search results
|
||||
- [ ] Support for a user's last searches
|
||||
- [ ] Improved search result summaries
|
||||
|
||||
@ -155,10 +156,10 @@ improvements (e.g. search) do not require any changes to existing configuration.
|
||||
This means that your users will be able to build the docs locally with the
|
||||
regular version and when they push their changes to CI/CD, they will be built
|
||||
with Material for MkDocs Insiders. For this reason, it's recommended to
|
||||
[install Insiders][18] only in CI, as you don't want to expose your `GH_TOKEN`
|
||||
[install Insiders][20] only in CI, as you don't want to expose your `GH_TOKEN`
|
||||
to users.
|
||||
|
||||
[18]: publishing-your-site.md#github-pages
|
||||
[20]: publishing-your-site.md#github-pages
|
||||
|
||||
### Terms
|
||||
|
||||
@ -168,7 +169,7 @@ terms?_
|
||||
|
||||
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][19]. However, we kindly ask you to respect the following
|
||||
by the [MIT license][21]. However, we kindly ask you to respect the following
|
||||
guidelines:
|
||||
|
||||
- Please __don't distribute the source code__ from Material for MkDocs Insiders.
|
||||
@ -179,7 +180,7 @@ guidelines:
|
||||
- If you cancel your subscription, you're removed as a collaborator and will
|
||||
miss out on future updates of Material for MkDocs 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][20]__.
|
||||
Just remember that __[GitHub deletes private forks][22]__.
|
||||
|
||||
[19]: license.md
|
||||
[20]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
|
||||
[21]: license.md
|
||||
[22]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
|
||||
|
Loading…
Reference in New Issue
Block a user