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
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
9694d232
Commit
9694d232
authored
7 years ago
by
squidfunk
Committed by
Martin Donath
7 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Updated screens and landing page documentation
parent
43484824
Branches
Branches containing commit
No related tags found
No related merge requests found
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
README.md
+21
-4
21 additions, 4 deletions
README.md
docs/images/material.png
+0
-0
0 additions, 0 deletions
docs/images/material.png
docs/index.md
+15
-1
15 additions, 1 deletion
docs/index.md
with
36 additions
and
5 deletions
README.md
+
21
−
4
View file @
9694d232
...
...
@@ -17,24 +17,41 @@
# Material for MkDocs
A Material Design theme for
[
MkDocs
]
(
http://www.mkdocs.org
)
.
A Material Design theme for
[
MkDocs
]
[
1
]
.
[

](http://squidfunk.github.io/mkdocs-material/)
[

][2]
[
1
]:
http://www.mkdocs.org
[
2
]:
http://squidfunk.github.io/mkdocs-material/
## Quick start
Install with
`pip`
:
Install
the latest version of Material
with
`pip`
:
```
sh
pip
install
mkdocs-material
```
Append the following line to your
existing
`mkdocs.yml`
:
Append the following line to your
project's
`mkdocs.yml`
:
```
yaml
theme
:
'
material'
```
## What to expect
*
Responsive design and fluid layout for all kinds of screens and devices,
designed to serve your project documentation in a user-friendly way with
optimal readability.
*
Easily customizable primary and accent color, fonts, favicon and logo;
straight forward localization through theme extension; integrated with Google
Analytics, Disqus and GitHub.
*
Well-designed search interface accessible through hotkeys (
<kbd>
F
</kbd>
or
<kbd>
S
</kbd>
), intelligent grouping of search results, search term
highlighting and lazy loading.
For detailed installation instructions and a demo, visit
http://squidfunk.github.io/mkdocs-material/
...
...
This diff is collapsed.
Click to expand it.
docs/images/material.png
+
0
−
0
View replaced file @
43484824
View file @
9694d232
757 KiB
|
W:
|
H:
1.28 MiB
|
W:
|
H:
2-up
Swipe
Onion skin
This diff is collapsed.
Click to expand it.
docs/index.md
+
15
−
1
View file @
9694d232
...
...
@@ -19,12 +19,26 @@ Install the latest version of Material with `pip`:
pip
install
mkdocs-material
```
A
d
d the following line to your
`mkdocs.yml`
:
A
ppen
d the following line to your
project's
`mkdocs.yml`
:
```
yaml
theme
:
'
material'
```
## What to expect
*
Responsive design and fluid layout for all kinds of screens and devices,
designed to serve your project documentation in a user-friendly way with
optimal readability.
*
Easily customizable primary and accent color, fonts, favicon and logo;
straight forward localization through theme extension; integrated with Google
Analytics, Disqus and GitHub.
*
Well-designed search interface accessible through hotkeys (
<kbd>
F
</kbd>
or
<kbd>
S
</kbd>
), intelligent grouping of search results, search term
highlighting and lazy loading.
For detailed instructions see the
[
getting started guide
][
3
]
.
[
3
]:
getting-started.md
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