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
43484824
Commit
43484824
authored
7 years ago
by
squidfunk
Committed by
Martin Donath
7 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Added notes on icon logo to documentation
parent
60d3a49a
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/getting-started.md
+42
-31
42 additions, 31 deletions
docs/getting-started.md
yarn.lock
+9
-8
9 additions, 8 deletions
yarn.lock
with
51 additions
and
39 deletions
docs/getting-started.md
+
42
−
31
View file @
43484824
...
...
@@ -303,10 +303,21 @@ extra:
logo
:
'
images/logo.svg'
```
Additionally, the default icon can be changed by setting an arbitrary ligature
(or Unicode code point) from the
[
Material Design icon font
][
16
]
, e.g.
```
yaml
extra
:
logo
:
icon
:
'
cloud'
```
[
16
]:
https://material.io/icons/
### Adding social links
Social accounts can be linked in the footer of the documentation using the
automatically included
[
FontAwesome
][
1
6
]
webfont. The
`type`
must denote the
automatically included
[
FontAwesome
][
1
7
]
webfont. The
`type`
must denote the
name of the social service, e.g.
`github`
,
`twitter`
or
`linkedin`
and the
`link`
must contain the URL you want to link to:
...
...
@@ -325,7 +336,7 @@ The links are generated in order and the `type` of the links must match the
name of the FontAwesome glyph. The
`fa`
is automatically added, so
`github`
will result in
`fa fa-github`
.
[
1
6
]:
http://fontawesome.io/icons/
[
1
7
]:
http://fontawesome.io/icons/
### Google Analytics integration
...
...
@@ -342,7 +353,7 @@ google_analytics:
### Disqus integation
Material for MkDocs is integrated with
[
Disqus
][
1
7
]
, so if you want to add a
Material for MkDocs is integrated with
[
Disqus
][
1
8
]
, so if you want to add a
comments section to your documentation set the shortname of your Disqus project
in your
`mkdocs.yml`
:
...
...
@@ -361,7 +372,7 @@ automatically included.
`site_url` value must be set in `mkdocs.yml` for the Disqus integration to
load properly.
[
1
7
]:
https://disqus.com
[
1
8
]:
https://disqus.com
### Localization
...
...
@@ -393,19 +404,19 @@ macro `t`:
```
Just copy the file from the original theme and make your adjustments. See the
section on
[
overriding partials
][
1
8
]
and the general guide on
[
theme extension
][
19
]
in the customization guide. Furthermore, see the
[
example configuration
][
2
0
]
for a head start.
section on
[
overriding partials
][
1
9
]
and the general guide on
[
theme extension
][
20
]
in the customization guide. Furthermore, see the
[
example configuration
][
2
1
]
for a head start.
[
1
8
]:
customization.md#overriding-partials
[
19
]:
customization.md#extending-the-theme
[
2
0
]:
https://github.com/squidfunk/mkdocs-material/tree/master/examples/language
[
1
9
]:
customization.md#overriding-partials
[
20
]:
customization.md#extending-the-theme
[
2
1
]:
https://github.com/squidfunk/mkdocs-material/tree/master/examples/language
#### Site search
Site search is implemented using
[
lunr.js
][
2
1
]
, which includes stemmers for the
Site search is implemented using
[
lunr.js
][
2
2
]
, which includes stemmers for the
English language by default, while stemmers for other languages are included
with
[
lunr-languages
][
2
2
]
, both of which are integrated with this theme. Support
with
[
lunr-languages
][
2
3
]
, both of which are integrated with this theme. Support
for other languages and even multilingual search can be activated by setting
the key
`search.languages`
to a comma-separated list of supported 2-letter
language codes, e.g.:
...
...
@@ -443,8 +454,8 @@ to index parts of words that are separated by `-` or `.` for example:
}
[
key
]
}}{%
endmacro
%}
```
[
2
1
]:
https://lunrjs.com
[
2
2
]:
https://github.com/MihaiValentin/lunr-languages
[
2
2
]:
https://lunrjs.com
[
2
3
]:
https://github.com/MihaiValentin/lunr-languages
### Tabs
...
...
@@ -462,13 +473,13 @@ extra:
### More advanced customization
If you want to change the general appearance of the Material theme, see
[
this article
][
2
3
]
for more information on advanced customization.
[
this article
][
2
4
]
for more information on advanced customization.
[
2
3
]:
customization.md
[
2
4
]:
customization.md
## Extensions
MkDocs supports several
[
Markdown extensions
][
2
4
]
. The following extensions
MkDocs supports several
[
Markdown extensions
][
2
5
]
. The following extensions
are not enabled by default (see the link for which are enabled by default)
but highly recommended, so they should be switched on at all times:
...
...
@@ -482,20 +493,20 @@ markdown_extensions:
For more information, see the following list of extensions supported by the
Material theme including more information regarding installation and usage:
*
[
Admonition
][
2
5
]
*
[
Codehilite
][
2
6
]
*
[
Footnotes
][
2
7
]
*
[
Metadata
][
2
8
]
*
[
Permalinks
][
29
]
*
[
PyMdown Extensions
][
3
0
]
[
2
4
]:
http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions
[
2
5
]:
extensions/admonition.md
[
2
6
]:
extensions/codehilite.md
[
2
7
]:
extensions/footnotes.md
[
2
8
]:
extensions/metadata.md
[
29
]:
extensions/permalinks.md
[
3
0
]:
extensions/pymdown.md
*
[
Admonition
][
2
6
]
*
[
Codehilite
][
2
7
]
*
[
Footnotes
][
2
8
]
*
[
Metadata
][
2
9
]
*
[
Permalinks
][
30
]
*
[
PyMdown Extensions
][
3
1
]
[
2
5
]:
http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions
[
2
6
]:
extensions/admonition.md
[
2
7
]:
extensions/codehilite.md
[
2
8
]:
extensions/footnotes.md
[
2
9
]:
extensions/metadata.md
[
30
]:
extensions/permalinks.md
[
3
1
]:
extensions/pymdown.md
## Full example
...
...
This diff is collapsed.
Click to expand it.
yarn.lock
+
9
−
8
View file @
43484824
...
...
@@ -1993,9 +1993,9 @@ flatten@^1.0.2:
version "1.0.2"
resolved "https://registry.yarnpkg.com/flatten/-/flatten-1.0.2.tgz#dae46a9d78fbe25292258cc1e780a41d95c03782"
flow-bin@^0.5
3
.0:
version "0.5
3.1
"
resolved "https://registry.yarnpkg.com/flow-bin/-/flow-bin-0.5
3.1
.tgz#
9b2
2b6
3a
23c9
9763ae533ebbab07f88c88c97d84
"
flow-bin@^0.5
4
.0:
version "0.5
4.0
"
resolved "https://registry.yarnpkg.com/flow-bin/-/flow-bin-0.5
4.0
.tgz#
f2fb0478e9e9970
2b623c9
ed84079a39903bba77
"
flow-jsdoc@^0.3.0:
version "0.3.0"
...
...
@@ -2474,15 +2474,16 @@ gulp-sourcemaps@^2.6.0:
through2 "2.X"
vinyl "1.X"
gulp-stylelint@^
4
.0.0:
version "
4
.0.0"
resolved "https://registry.yarnpkg.com/gulp-stylelint/-/gulp-stylelint-
4
.0.0.tgz#
440fa7e6c447e92644700e1e2a06a73e6e45775
0"
gulp-stylelint@^
5
.0.0:
version "
5
.0.0"
resolved "https://registry.yarnpkg.com/gulp-stylelint/-/gulp-stylelint-
5
.0.0.tgz#
c507f5e314602e7122eff599f2880eb0b62657b
0"
dependencies:
chalk "^2.0.1"
deep-extend "^0.5.0"
gulp-util "^3.0.8"
mkdirp "^0.5.1"
promise "^8.0.1"
source-map "^0.5.6"
strip-ansi "^4.0.0"
stylelint "^8.0.0"
through2 "^2.0.3"
...
...
@@ -5604,7 +5605,7 @@ vinyl@^0.5.0:
clone-stats "^0.0.1"
replace-ext "0.0.1"
vinyl@^2.0.0
, vinyl@^2.0.1
:
vinyl@^2.0.0:
version "2.0.1"
resolved "https://registry.yarnpkg.com/vinyl/-/vinyl-2.0.1.tgz#1c3b4931e7ac4c1efee743f3b91a74c094407bb6"
dependencies:
...
...
@@ -5616,7 +5617,7 @@ vinyl@^2.0.0, vinyl@^2.0.1:
remove-trailing-separator "^1.0.1"
replace-ext "^1.0.0"
vinyl@^2.1.0:
vinyl@^2.0.1,
vinyl@^2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/vinyl/-/vinyl-2.1.0.tgz#021f9c2cf951d6b939943c89eb5ee5add4fd924c"
dependencies:
...
...
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