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
b913a607
Commit
b913a607
authored
Oct 31, 2017
by
squidfunk
Committed by
Martin Donath
Oct 31, 2017
Browse files
Options
Downloads
Patches
Plain Diff
Updated documentation for installation
parent
f68d7beb
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
README.md
+2
-1
2 additions, 1 deletion
README.md
docs/customization.md
+7
-5
7 additions, 5 deletions
docs/customization.md
with
9 additions
and
6 deletions
README.md
+
2
−
1
View file @
b913a607
...
@@ -35,7 +35,8 @@ pip install mkdocs-material
...
@@ -35,7 +35,8 @@ pip install mkdocs-material
Append the following line to your project's
`mkdocs.yml`
:
Append the following line to your project's
`mkdocs.yml`
:
```
yaml
```
yaml
theme
:
'
material'
theme
:
name
:
'
material'
```
```
## What to expect
## What to expect
...
...
This diff is collapsed.
Click to expand it.
docs/customization.md
+
7
−
5
View file @
b913a607
...
@@ -71,18 +71,19 @@ main theme.
...
@@ -71,18 +71,19 @@ main theme.
### Setup and theme structure
### Setup and theme structure
Reference the Material theme as usual in your
`mkdocs.yml`
, and create a
Reference the Material theme as usual in your
`mkdocs.yml`
, and create a
new folder for overrides, e.g.
`theme`
, which you reference using
`
theme
_dir`
:
new folder for overrides, e.g.
`theme`
, which you reference using
`
custom
_dir`
:
```
yaml
```
yaml
theme
:
'
material'
theme
:
theme_dir
:
'
theme'
name
:
'
material'
custom_dir
:
'
theme'
```
```
!!! warning "Theme extension prerequisites"
!!! warning "Theme extension prerequisites"
As the `
theme
_dir` variable is used for the theme extension process, the
As the `
custom
_dir` variable is used for the theme extension process, the
Material theme needs to be installed via `pip` and referenced with the
Material theme needs to be installed via `pip` and referenced with the
`
the
me` parameter in your `mkdocs.yml`.
`
na
me` parameter in your `mkdocs.yml`.
The structure in the theme directory must mirror the directory structure of the
The structure in the theme directory must mirror the directory structure of the
original theme, as any file in the theme directory will replace the file with
original theme, as any file in the theme directory will replace the file with
...
@@ -98,6 +99,7 @@ The directory layout of the Material theme is as follows:
...
@@ -98,6 +99,7 @@ The directory layout of the Material theme is as follows:
│ ├─ javascripts/
# JavaScript
│ ├─ javascripts/
# JavaScript
│ └─ stylesheets/
# Stylesheets
│ └─ stylesheets/
# Stylesheets
├─ partials/
├─ partials/
│ ├─ language/
# Localized languages
│ ├─ disqus.html
# Disqus integration
│ ├─ disqus.html
# Disqus integration
│ ├─ footer.html
# Footer bar
│ ├─ footer.html
# Footer bar
│ ├─ header.html
# Header bar
│ ├─ header.html
# Header bar
...
...
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