Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
mkdocs-material
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
Janne Mareike Koschinski
mkdocs-material
Commits
6f324afb
Commit
6f324afb
authored
Jan 14, 2017
by
squidfunk
Browse files
Options
Downloads
Patches
Plain Diff
Put choco under general installation procedures
parent
cf17f3b7
No related branches found
No related tags found
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/getting-started.md
+18
-17
18 additions, 17 deletions
docs/getting-started.md
mkdocs.yml
+1
-1
1 addition, 1 deletion
mkdocs.yml
with
19 additions
and
18 deletions
docs/getting-started.md
+
18
−
17
View file @
6f324afb
...
...
@@ -41,7 +41,7 @@ pip install pymdown-extensions
### Installing Material
####
by
using pip
#### using pip
Material can be installed with
`pip`
:
...
...
@@ -63,7 +63,23 @@ pip install mkdocs-material
to a self-contained solution by installing Python with Homebrew. This
should eliminate a lot of problems you may be having with `pip`.
#### by cloning from GitHub
#### using choco
If you're on Windows you can use
[
Chocolatey
][
5
]
to install
[
Material
][
6
]
:
```
dos
choco install mkdocs-material
```
This will also install all required dependencies like
[
Python
][
7
]
and
[
MkDocs
][
8
]
.
[
5
]:
https://chocolatey.org
[
6
]:
https://chocolatey.org/packages/mkdocs-material
[
8
]:
https://chocolatey.org/packages/python
[
7
]:
https://chocolatey.org/packages/mkdocs
#### cloning from GitHub
Material can also be used without a system-wide installation by cloning the
repository into a subfolder of your project's root directory:
...
...
@@ -76,21 +92,6 @@ This is especially useful if you want to extend the theme and override some
parts of the theme. The theme will reside in the folder
`mkdocs-material/material`
.
### Installing using Chocolatey
If you're on Windows you can use
[
Chocolatey
][
5
]
to install
[
mkdocs-material
][
6
]
:
```
dos
choco install mkdocs-material
```
Installing
[
mkdocs-material
][
6
]
will take care of installing all required dependencies like
[
mkdocs
][
7
]
and
[
Python
][
8
]
.
[
5
]:
https://chocolatey.org
[
6
]:
https://chocolatey.org/packages/mkdocs-material
[
7
]:
https://chocolatey.org/packages/mkdocs
[
8
]:
https://chocolatey.org/packages/Python
## Usage
In order to enable the Material theme just add one of the following lines to
...
...
This diff is collapsed.
Click to expand it.
mkdocs.yml
+
1
−
1
View file @
6f324afb
...
...
@@ -29,7 +29,7 @@ repo_name: squidfunk/mkdocs-material
repo_url
:
https://github.com/squidfunk/mkdocs-material
# Copyright
copyright
:
'
Copyright
©
2016
Martin
Donath'
copyright
:
'
Copyright
©
2016
-2017
Martin
Donath'
# Documentation and theme
theme_dir
:
material
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment