Added sponsorship terms

This commit is contained in:
squidfunk 2020-07-22 18:30:00 +02:00
parent 5fafecaa7c
commit 7728bef1ec
6 changed files with 50 additions and 15 deletions

View File

@ -22,18 +22,32 @@ In case you're running into problems, consult the [troubleshooting][4] section.
Material for MkDocs can be installed with `pip`:
``` sh
pip install mkdocs-material
```
=== "Community edition"
``` sh
pip install mkdocs-material
```
=== "Sponsor edition"
``` sh
pip install git+https://$GH_TOKEN@github.com/squidfunk/mkdocs-material-next.git
```
This will automatically install compatible versions of all dependencies:
[MkDocs][1], [Markdown][5], [Pygments][6] and [PyMdown Extensions][7]. Material
for MkDocs always strives to support the latest versions, so there's no need to
install those packages separately.
Note that in order to install the [sponsor edition][8], you'll need to create a
[personal access token][9] and set the `GH_TOKEN` environment variable to the
token's value.
[5]: https://python-markdown.github.io/
[6]: https://pygments.org/
[7]: https://facelessuser.github.io/pymdown-extensions/
[8]: sponsorship.md
[9]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
### with docker
@ -49,7 +63,7 @@ The `mkdocs` executable is provided as an entry point and `serve` is the
default command. If you're not familar with Docker don't worry, we have you
covered in the following sections.
[8]: https://hub.docker.com/r/squidfunk/mkdocs-material/
[10]: https://hub.docker.com/r/squidfunk/mkdocs-material/
### with git
@ -57,9 +71,17 @@ Material for MkDocs can be directly used from [GitHub][9] by cloning the
repository into a subfolder of your project root which might be useful if you
want to use the very latest version:
``` sh
git clone https://github.com/squidfunk/mkdocs-material.git
```
=== "Community edition"
``` sh
git clone https://github.com/squidfunk/mkdocs-material.git
```
=== "Sponsor edition"
``` sh
git clone git@github.com:squidfunk/mkdocs-material-next.git mkdocs-material
```
The theme will reside in the folder `mkdocs-material/material`. Note that when
cloning from `git`, you must install all required dependencies yourself:
@ -68,4 +90,4 @@ cloning from `git`, you must install all required dependencies yourself:
pip install -r mkdocs-material/requirements.txt
```
[9]: https://github.com/squidfunk/mkdocs-material
[11]: https://github.com/squidfunk/mkdocs-material

View File

@ -6,11 +6,6 @@ template: overrides/main.html
TBD
<!-- Material for MkDocs supports several flavors of lists that cater to different
use cases, including _unordered lists_ and _ordered lists_, which are supported
through standard Markdown, as well as _definition lists_ and _task lists_, which
are supported through extensions. -->
## Configuration
### Metadata

View File

@ -94,3 +94,21 @@ of a single documentation project, with the help of a plugin.
Add an alternative, completely different _vertical layout_, optimized to read
documentation and code side-by-side, e.g. for the documentation of APIs.
## Terms
Regardless of whether you're an individual or a company, you may use the
_sponsor edition_ exactly under the same terms as the _community edition_,
which are given by the [MIT license][12]. However, we kindly ask you to respect
the following guidelines:
- Please __don't distribute the source code__ from the _sponsor edition_.
You may freely use it for public, private or commercial projects, fork it,
mirror it, do whatever you want with it, as long as you're not releasing the
source code, as this would cannibalize the sponsorware model.
- If you cancel your subscription, you're removed as a collaborator and will not
receive future updates of the sponsor edition. However, you may continue to
use the latest version that's available to you for as long as you like.
[12]: license.md

View File

@ -143,9 +143,9 @@ nav:
- Creating your site: creating-your-site.md
- Publishing your site: publishing-your-site.md
- Customization: customization.md
- Sponsorship: sponsorship.md
#- Troubleshooting: troubleshooting.md
- Troubleshooting: troubleshooting.md
- Data privacy: data-privacy.md
- Sponsorship: sponsorship.md
- License: license.md
- Setup:
- Changing the colors: setup/changing-the-colors.md