OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fixed buttons in getting started guide

Browse Source
This commit is contained in:
squidfunk 2017-11-03 14:25:37 +01:00 committed by Martin Donath
parent f6a6638c78
commit dec7e21243
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/getting-started.md
View File

@ -474,7 +474,7 @@ extra:
disqus: 'your-disqus-shortname' disqus: 'your-disqus-shortname'
``` ```
The comments section is inserted in *every page, except the index page*. The comments section is inserted on *every page, except the index page*.
Additionally, a new entry at the bottom of the table of contents is generated Additionally, a new entry at the bottom of the table of contents is generated
that is linking to the comments section. The necessary JavaScript is that is linking to the comments section. The necessary JavaScript is
automatically included. automatically included.
@ -494,15 +494,15 @@ automatically included.
changes to the way themes can define options. The following variables inside changes to the way themes can define options. The following variables inside
your project's `mkdocs.yml` need to be renamed: your project's `mkdocs.yml` need to be renamed:
* `extra.feature` becomes `theme.feature` * `extra.feature` becomes `theme.feature`
* `extra.palette` becomes `theme.palette` * `extra.palette` becomes `theme.palette`
* `extra.font` becomes `theme.font` * `extra.font` becomes `theme.font`
* `extra.logo` becomes `theme.logo` * `extra.logo` becomes `theme.logo`
* Favicon support has been dropped by MkDocs, it must now be defines in * Favicon support has been dropped by MkDocs, it must now be defined in
`theme.favicon` (previously `site_favicon`). `theme.favicon` (previously `site_favicon`).
* Localization is now separate in theme language and search language. While * Localization is now separated into theme language and search language. While
there can only be a single language on theme-level, the search supports there can only be a single language on theme-level, the search supports
multiple languages which can be separated by commas. multiple languages which can be separated by commas.

10
mkdocs.yml
View File

@ -32,7 +32,7 @@ edit_uri: ""
# Copyright # Copyright
copyright: 'Copyright © 2016 - 2017 Martin Donath' copyright: 'Copyright © 2016 - 2017 Martin Donath'
# Theme directory # Configuration
theme: theme:
name: null name: null
custom_dir: material custom_dir: material
@ -46,8 +46,8 @@ theme:
feature: feature:
tabs: false tabs: false
palette: palette:
primary: primary: indigo
accent: accent: indigo
font: font:
text: Roboto text: Roboto
code: Roboto Mono code: Roboto Mono
@ -55,7 +55,7 @@ theme:
logo: logo:
icon: "\uE80C" icon: "\uE80C"
# Options # Customization
extra: extra:
social: social:
- type: globe - type: globe
@ -118,4 +118,4 @@ google_analytics:
# Just for testing # Just for testing
extra_javascript: extra_javascript:
- http://ginseng-analytics.com/analytics.js - https://ginseng-analytics.com/analytics.js