1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
---
title: Getting started with Insiders
---
# Getting started with Insiders
Material for MkDocs Insiders is a compatible drop-in replacement for Material
for MkDocs, and can be installed similarly using [`pip`][pip],
[`docker`][docker] or [`git`][git]. Note that in order to access the Insiders
repository, you need to [become an eligible sponsor] of @squidfunk on GitHub.
[pip]: #with-pip
[docker]: #with-docker
[git]: #with-git
[become an eligible sponsor]: how-to-sponsor.md
## Requirements
After you've been added to the list of collaborators and accepted the
repository invitation, the next step is to create a [personal access token] for
your GitHub account in order to access the Insiders repository programmatically
(from the command line or GitHub Actions workflows):
1. Go to https://github.com/settings/tokens
2. Click on [Generate a new token]
3. Enter a name and select the [`repo`][scopes] scope
4. Generate the token and store it in a safe place
[personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
[Generate a new token]: https://github.com/settings/tokens/new
[scopes]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
Some of the instructions below require that the `GH_TOKEN` environment
variable is set to the value of the personal access token you
generated in the previous step. Note that the personal access token
must be kept secret at all times, as it allows the owner to access
your private repositories.
## Installation
### with pip
Material for MkDocs Insiders can be installed with `pip`. You will
normally want to install the latest release but can also install a
specific older release or even the latest development version.
Make sure you have the `GH_TOKEN` variable set as instructed above.
=== "Specific release"
Pick the corresponding tag from the [list of tags] for the Insiders
repository. In the `pip` command below, replace the tag at the
end of the URL with the one you want.
``` sh
pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0
```
=== "Latest"
``` sh
pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
```
[list of tags]: https://github.com/squidfunk/mkdocs-material-insiders/tags
### with docker
In case you want to use Material for MkDocs Insiders from within Docker, some
additional steps are necessary. While we cannot provide a hosted Docker image
for Insiders[^2], [GitHub Container Registry] allows for simple and
comfortable self-hosting:
1. [Fork the Insiders repository]
2. Enable [GitHub Actions] on your fork[^3]
3. Create a new personal access token[^4]
1. Go to https://github.com/settings/tokens
2. Click on [Generate a new token]
3. Enter a name and select the [`write:packages`][scopes] scope
4. Generate the token and store it in a safe place
4. Add a [GitHub Actions secret] on your fork
1. Set the name to `GHCR_TOKEN`
2. Set the value to the personal access token created in the previous step
5. [Create a new release] to build and publish the Docker image
6. Install [Pull App] on your fork to stay in-sync with upstream
The [`build`][build] workflow is automatically run when a new tag
(release) is created. When a new Insiders version is released on the upstream
repository, the [Pull App] will create a pull request with the changes and
pull in the new tag, which is picked up by the [`build`][build] workflow
that builds and publishes the Docker image automatically to your private
registry.
Now, you should be able to pull the Docker image from your private registry:
```
docker login -u ${GH_USERNAME} -p ${GHCR_TOKEN} ghcr.io
docker pull ghcr.io/${GH_USERNAME}/mkdocs-material-insiders
```
Should you wish to add additional plugins to the insiders container image, follow the steps
outlined in the [Getting Started guide](../getting-started.md#with-docker).
[^2]:
Earlier, Insiders provided a dedicated Docker image which was available to
all sponsors. On March 21, 2021, the image was deprecated for the reasons
outlined and discussed in #2442. It was removed on June 1, 2021.
[^3]:
When forking a repository, GitHub will disable all workflows. While this
is a reasonable default setting, you need to enable GitHub Actions to be
able to automatically build and publish a Docker image on
[GitHub Container Registry].
[^4]:
While you could just add the `write:packages` scope to the personal access
token created to access the Insiders repository, it's safer to create a
dedicated token which you'll only use for publishing the Docker image.
### with git
Of course, you can use Material for MkDocs Insiders directly from `git`:
```
git clone git@github.com:squidfunk/mkdocs-material-insiders.git mkdocs-material
```
The theme will reside in the folder `mkdocs-material/material`. When cloning
from `git`, the theme must be installed, so MkDocs can find the built-in
plugins:
```
pip install -e mkdocs-material
```
[GitHub Container Registry]: https://docs.github.com/en/packages/guides/about-github-container-registry
[Fork the Insiders repository]: https://github.com/squidfunk/mkdocs-material-insiders/fork
[GitHub Actions]: https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository
[packages scope]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
[GitHub Actions secret]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository
[Create a new release]: https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release
[Pull App]: https://github.com/apps/pull
[build]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/build.yml
## Built-in plugins
When you're using built-in plugins that are solely available via Insiders,
outside contributors won't be able to build your documentation project on their
local machine. This is the reason why we developed the [built-in group plugin]
that allows to conditionally load plugins:
``` yaml
plugins:
- search
- social
# CI=true mkdocs build
- group:
enabled: !ENV CI
plugins:
- git-revision-date-localized
- git-committers
# INSIDERS=true mkdocs build
- group:
enabled: !ENV INSIDERS
plugins:
- optimize
- privacy
```
Of course, you can also enable both groups with:
``` shell
CI=true INSIDERS=true mkdocs build
```
[built-in group plugin]: ../plugins/group.md
[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance
|
