starred/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2026-07-30 01:32:39 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add option to link to GitHub release.

Browse Source
This commit is contained in:
Orne Brocaar
2016-06-29 18:14:25 +02:00
parent 57f51f3a3d
commit 56d252c6bb
4 changed files with 45 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/getting-started.md
View File

@@ -103,6 +103,25 @@ extra:
logo: 'images/logo.png'
```
### Link to GitHub releases page
If your project has a GitHub url configured, the default behavior is that a
downlink button is displayed, linking to the source download of the given
`extra.version` or `master` branch. To link to the releases page instead,
set `extra.github.download_release` to `true`. It will link to the release of
the given `extra.version` or when no `extra.version` is given, the latest
release:
``` yaml
repo_name: GitHub
repo_url: https://github.com/squidfunk/mkdocs-material
extra:
github:
download_release: true
```
### Changing the color palette
Material defines a default hue for every primary and accent color on Google's