From 7728bef1eca5918ba016256784154a70d015449a Mon Sep 17 00:00:00 2001 From: squidfunk Date: Wed, 22 Jul 2020 18:30:00 +0200 Subject: [PATCH] Added sponsorship terms --- docs/getting-started.md | 38 +++++++++++++++++++----- docs/reference/meta-tags.md | 5 ---- docs/setup/adding-a-landing-page.md | 0 docs/setup/adding-an-announcement-bar.md | 0 docs/sponsorship.md | 18 +++++++++++ mkdocs.yml | 4 +-- 6 files changed, 50 insertions(+), 15 deletions(-) delete mode 100644 docs/setup/adding-a-landing-page.md delete mode 100644 docs/setup/adding-an-announcement-bar.md diff --git a/docs/getting-started.md b/docs/getting-started.md index a877a2a53..cf01b74f4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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 diff --git a/docs/reference/meta-tags.md b/docs/reference/meta-tags.md index 628d9c503..7af2ef4ea 100644 --- a/docs/reference/meta-tags.md +++ b/docs/reference/meta-tags.md @@ -6,11 +6,6 @@ template: overrides/main.html TBD - - ## Configuration ### Metadata diff --git a/docs/setup/adding-a-landing-page.md b/docs/setup/adding-a-landing-page.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/setup/adding-an-announcement-bar.md b/docs/setup/adding-an-announcement-bar.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/sponsorship.md b/docs/sponsorship.md index b8fc4d46f..1458ca6a8 100644 --- a/docs/sponsorship.md +++ b/docs/sponsorship.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 8a6183520..3fe364d0f 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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