mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-28 01:10:58 +01:00
Added list of available features to Insiders docs
This commit is contained in:
parent
f9f48c09c1
commit
032bdb2b53
@ -13,16 +13,6 @@ and how you can [become a sponsor][3].
|
|||||||
[2]: #how-sponsorship-works
|
[2]: #how-sponsorship-works
|
||||||
[3]: #how-to-become-a-sponsor
|
[3]: #how-to-become-a-sponsor
|
||||||
|
|
||||||
<div style="width:100%;height:0px;position:relative;padding-bottom:56.138%;">
|
|
||||||
<iframe src="https://streamable.com/e/lz4me5" frameborder="0" width="100%" height="100%" allowfullscreen style="width:100%;height:100%;position:absolute;left:0px;top:0px;overflow:hidden;"></iframe>
|
|
||||||
</div>
|
|
||||||
<p style="text-align: center; font-style: oblique">
|
|
||||||
A demo is worth a thousand words — check it out at <br />
|
|
||||||
<a href="https://squidfunk.github.io/mkdocs-material-insiders/">
|
|
||||||
squidfunk.github.io/mkdocs-material-insiders
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
## How sponsorship works
|
## How sponsorship works
|
||||||
|
|
||||||
New features will first land in Material for MkDocs Insiders, which means that
|
New features will first land in Material for MkDocs Insiders, which means that
|
||||||
@ -64,13 +54,30 @@ monthly subscription, which you can do at any time.__
|
|||||||
[9]: https://gitlab.com
|
[9]: https://gitlab.com
|
||||||
[10]: https://bitbucket.org
|
[10]: https://bitbucket.org
|
||||||
|
|
||||||
|
## Available features
|
||||||
|
|
||||||
|
The following list shows which features are currently only available in Material
|
||||||
|
for MkDocs Insiders. You can click on each feature to learn more about it:
|
||||||
|
|
||||||
|
- [x] [Support for user-toggleable themes (light/dark mode switch)][11]
|
||||||
|
- [x] [Highlighting of matched search terms in content area][12]
|
||||||
|
- [x] [Navigation can always be expanded via configuration][13]
|
||||||
|
- [x] [Header can be automatically hidden on scrolling][14]
|
||||||
|
- [x] [Table of contents can be automatically hidden when empty][15]
|
||||||
|
|
||||||
|
[11]: setup/changing-the-colors.md#color-palette-toggle
|
||||||
|
[12]: setup/setting-up-site-search.md#highlighting-search
|
||||||
|
[13]: setup/setting-up-navigation.md#navigation-expansion
|
||||||
|
[14]: setup/setting-up-the-header.md#automatic-hiding
|
||||||
|
[15]: setup/setting-up-navigation.md#automatic-hiding
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
The following list of funding goals – named after varieties of chili peppers
|
The following list of funding goals – named after varieties of chili peppers
|
||||||
[I'm growing on my balcony][11] – shows which features are already available
|
[I'm growing on my balcony][16] – shows which features are already available
|
||||||
in Material for MkDocs Insiders.
|
in Material for MkDocs Insiders.
|
||||||
|
|
||||||
[11]: https://www.instagram.com/squidfunk/
|
[16]: https://www.instagram.com/squidfunk/
|
||||||
|
|
||||||
### Madame Jeanette
|
### Madame Jeanette
|
||||||
|
|
||||||
@ -90,15 +97,14 @@ New features and improvements for _search_, including:
|
|||||||
|
|
||||||
New features and improvements for _content and toc_, including:
|
New features and improvements for _content and toc_, including:
|
||||||
|
|
||||||
- [x] Highlighting of matched search terms in content area
|
- [x] [Highlighting of matched search terms in content area][12]
|
||||||
- [x] Navigation can always be expanded via configuration
|
- [x] [Navigation can always be expanded via configuration][13]
|
||||||
- [x] Header can be automatically hidden on scrolling
|
- [x] [Header can be automatically hidden on scrolling][14]
|
||||||
- [x] Table of contents can be automatically hidden when empty
|
- [x] [Table of contents can be automatically hidden when empty][15]
|
||||||
- [ ] Table of contents can be moved into navigation for more space
|
- [ ] Table of contents can be moved into navigation for more space
|
||||||
- [ ] Table of contents shows which sections have search results
|
- [ ] Table of contents shows which sections have search results
|
||||||
- [ ] Table of contents auto-collapses and expands only the active section
|
- [ ] Table of contents auto-collapses and expands only the active section
|
||||||
- [ ] Better support for wide screens, i.e. more horizontal space
|
- [ ] Better support for wide screens, i.e. more horizontal space
|
||||||
- [ ] ... more to come
|
|
||||||
|
|
||||||
### Bhut Jolokia
|
### Bhut Jolokia
|
||||||
|
|
||||||
@ -110,7 +116,6 @@ New features and improvements for _hosting multiple versions_, including:
|
|||||||
- [ ] Support for multiple languages of documents
|
- [ ] Support for multiple languages of documents
|
||||||
- [ ] Support for multiple versions of documents
|
- [ ] Support for multiple versions of documents
|
||||||
- [ ] Support for one or more management plugins
|
- [ ] Support for one or more management plugins
|
||||||
- [ ] ... more to come
|
|
||||||
|
|
||||||
### Black Pearl
|
### Black Pearl
|
||||||
|
|
||||||
@ -119,11 +124,19 @@ New features and improvements for _hosting multiple versions_, including:
|
|||||||
|
|
||||||
New features and improvements for _user preferences_, including:
|
New features and improvements for _user preferences_, including:
|
||||||
|
|
||||||
- [x] Support for user-toggleable themes
|
- [x] [Support for user-toggleable themes (light/dark mode switch)][11]
|
||||||
- [ ] Support for user-toggleable code-block styles (light/dark)
|
- [ ] Support for user-toggleable code-block styles (light/dark mode switch)
|
||||||
- [ ] Display last searches when search is empty
|
|
||||||
|
### Biquinho Vermelho
|
||||||
|
|
||||||
|
[:octicons-flame-24: Funding goal: __$2,500__][6] ·
|
||||||
|
:octicons-lock-24: Status: _exclusive_
|
||||||
|
|
||||||
|
Even more features and improvements for _search_, including:
|
||||||
|
|
||||||
|
- [ ] Support for search suggestions
|
||||||
|
- [ ] Support for a user's last searches
|
||||||
- [ ] Improved search result summaries
|
- [ ] Improved search result summaries
|
||||||
- [ ] ... more to come
|
|
||||||
|
|
||||||
### Caribbean Red
|
### Caribbean Red
|
||||||
|
|
||||||
@ -147,7 +160,7 @@ 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
|
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
|
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
|
with Material for MkDocs Insiders. For this reason, it's recommended to
|
||||||
[install Insiders][12] only in CI, as you don't want to expose your `GH_TOKEN`
|
[install Insiders][17] only in CI, as you don't want to expose your `GH_TOKEN`
|
||||||
to users.
|
to users.
|
||||||
|
|
||||||
### Terms
|
### Terms
|
||||||
@ -158,7 +171,7 @@ terms?_
|
|||||||
|
|
||||||
Yes. Whether you're an individual or a company, you may use _Material for MkDocs
|
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
|
Insiders_ precisely under the same terms as Material for MkDocs, which are given
|
||||||
by the [MIT license][13]. However, we kindly ask you to respect the following
|
by the [MIT license][18]. However, we kindly ask you to respect the following
|
||||||
guidelines:
|
guidelines:
|
||||||
|
|
||||||
- Please __don't distribute the source code__ from Material for MkDocs Insiders.
|
- Please __don't distribute the source code__ from Material for MkDocs Insiders.
|
||||||
@ -169,8 +182,8 @@ guidelines:
|
|||||||
- If you cancel your subscription, you're removed as a collaborator and will
|
- 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
|
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__.
|
__use the latest version__ that's available to you __as long as you like__.
|
||||||
Just remember that __[GitHub deletes private forks][14]__.
|
Just remember that __[GitHub deletes private forks][19]__.
|
||||||
|
|
||||||
[12]: publishing-your-site.md#github-pages
|
[17]: publishing-your-site.md#github-pages
|
||||||
[13]: license.md
|
[18]: license.md
|
||||||
[14]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
|
[19]: 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