mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2025-02-17 18:49:21 +01:00
Documentation
This commit is contained in:
parent
180b4c934d
commit
905af43634
@ -96,8 +96,8 @@ want to use the very latest version:
|
|||||||
git clone git@github.com:squidfunk/mkdocs-material-insiders.git mkdocs-material
|
git clone git@github.com:squidfunk/mkdocs-material-insiders.git mkdocs-material
|
||||||
```
|
```
|
||||||
|
|
||||||
The theme will reside in the folder `mkdocs-material/material`. Note that when
|
The theme will reside in the folder `mkdocs-material/material`. When cloning
|
||||||
cloning from `git`, you must install all required dependencies yourself:
|
from `git`, you must install all required dependencies yourself:
|
||||||
|
|
||||||
```
|
```
|
||||||
pip install -r mkdocs-material/requirements.txt
|
pip install -r mkdocs-material/requirements.txt
|
||||||
@ -110,10 +110,10 @@ need to [become a sponsor][9]._
|
|||||||
|
|
||||||
[^1]:
|
[^1]:
|
||||||
In order to use `pip` to install from the private repository over HTTPS, the
|
In order to use `pip` to install from the private repository over HTTPS, the
|
||||||
personal access token requires the [`repo`][17] scope. Note that the usage
|
personal access token requires the [`repo`][17] scope. The creation and
|
||||||
of an access token is only necessary when installing Insiders over HTTPS,
|
usage of an access token is only necessary when installing Insiders over
|
||||||
which is the recommended way when building from within a CI/CD workflow,
|
HTTPS, which is the recommended way when building from within a CI/CD
|
||||||
e.g. using [GitHub Pages][18] or [GitLab Pages][19].
|
workflow, e.g. using [GitHub Pages][18] or [GitLab Pages][19].
|
||||||
|
|
||||||
[17]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
|
[17]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
|
||||||
[18]: publishing-your-site.md#github-pages
|
[18]: publishing-your-site.md#github-pages
|
||||||
|
Loading…
x
Reference in New Issue
Block a user