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

Merge branch 'master' of github.com:squidfunk/mkdocs-material

Browse Source
This commit is contained in:
squidfunk
2016-10-10 09:44:01 +02:00
parent 50be5f8712 0dec429a9a
commit 68b1800d38
19 changed files with 76 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -5,6 +5,13 @@
A material design theme for [MkDocs](http://www.mkdocs.org).
**Note: the theme is currently undergoing a complete rewrite for 1.0.0 which should be
released shortly.**
* To get a glimpse, checkout the
[rework](https://github.com/squidfunk/mkdocs-material/tree/rework) branch
* To give feedback on the rework version, please see issues [#46](https://github.com/squidfunk/mkdocs-material/issues/46)
[![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/)
## Quick start
@@ -48,7 +55,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg
[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg?branch=master
[travis-link]: https://travis-ci.org/squidfunk/mkdocs-material
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material

2
bower.json
View File

@@ -20,7 +20,7 @@
"classlist": "^2014.12.13",
"fastclick": "^1.0.6",
"lunr.js": "^0.6.0",
"pegasus": "^0.3.2",
"pegasus": "0.3.3",
"respond": "^1.4.2"
},
"devDependencies": {

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

1
material/assets/javascripts/application-82b5011116.js Normal file
View File

File diff suppressed because one or more lines are too long

1
material/assets/javascripts/application-997097ee0c.js
View File

File diff suppressed because one or more lines are too long

2
material/assets/javascripts/application.js
View File

File diff suppressed because one or more lines are too long

1
material/assets/javascripts/modernizr-2216498cab.js Normal file
View File

File diff suppressed because one or more lines are too long

1
material/assets/javascripts/modernizr-4ab42b99fd.js
View File

File diff suppressed because one or more lines are too long

2
material/assets/javascripts/modernizr.js
View File

File diff suppressed because one or more lines are too long

2
material/assets/stylesheets/application-a422ff04cc.css → material/assets/stylesheets/application-e576885f03.css
View File

File diff suppressed because one or more lines are too long

2
material/assets/stylesheets/application.css
View File

File diff suppressed because one or more lines are too long

2
material/assets/stylesheets/palettes-05ab2406df.css → material/assets/stylesheets/palettes-2d6c5d2926.css
View File

File diff suppressed because one or more lines are too long

2
material/assets/stylesheets/palettes.css
View File

File diff suppressed because one or more lines are too long

16
material/base.html
View File

@@ -1,8 +1,8 @@
<!DOCTYPE html>
<!--[if lt IE 7 ]><html class="no-js ie6"><![endif]-->
<!--[if IE 7 ]><html class="no-js ie7"><![endif]-->
<!--[if IE 8 ]><html class="no-js ie8"><![endif]-->
<!--[if IE 9 ]><html class="no-js ie9"><![endif]-->
<!--[if lt IE 7 ]> <html class="no-js ie6"> <![endif]-->
<!--[if IE 7 ]> <html class="no-js ie7"> <![endif]-->
<!--[if IE 8 ]> <html class="no-js ie8"> <![endif]-->
<!--[if IE 9 ]> <html class="no-js ie9"> <![endif]-->
<!--[if (gt IE 9)|!(IE)]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
@@ -53,9 +53,9 @@
font-style: normal;
}
</style>
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-a422ff04cc.css">
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-e576885f03.css">
{% if config.extra.palette %}
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/palettes-05ab2406df.css">
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/palettes-2d6c5d2926.css">
{% endif %}
{% if config.extra.font != "none" %}
{% set text = config.extra.get("font", {}).text | default("Ubuntu") %}
@@ -74,7 +74,7 @@
{% for path in extra_css %}
<link rel="stylesheet" href="{{ path }}">
{% endfor %}
<script src="{{ base_url }}/assets/javascripts/modernizr-4ab42b99fd.js"></script>
<script src="{{ base_url }}/assets/javascripts/modernizr-2216498cab.js"></script>
{% block extrahead %}{% endblock %}
</head>
{% set palette = config.extra.get("palette", {}) %}
@@ -139,7 +139,7 @@
var base_url = '{{ base_url }}';
var repo_id = '{{ repo_id }}';
</script>
<script src="{{ base_url }}/assets/javascripts/application-997097ee0c.js"></script>
<script src="{{ base_url }}/assets/javascripts/application-82b5011116.js"></script>
{% for path in extra_javascript %}
<script src="{{ path }}"></script>
{% endfor %}

15
material/drawer.html
View File

@@ -26,10 +26,17 @@
{% if repo_name == "GitHub" and repo_url %}
<ul class="repo">
<li class="repo-download">
{% set version = config.extra.version | default("master") %}
<a href="{{ repo_url }}/archive/{{ version }}.zip" target="_blank" title="Download" data-action="download">
<i class="icon icon-download"></i> Download
</a>
{% if config.extra.github and config.extra.github.download_release %}
{% set version = config.extra.version | default("../latest") %}
<a href="{{ repo_url }}/releases/tag/{{ version }}" target="_blank" title="Download" data-action="download">
<i class="icon icon-download"></i> Download
</a>
{% else %}
{% set version = config.extra.version | default("master") %}
<a href="{{ repo_url }}/archive/{{ version }}.zip" target="_blank" title="Download" data-action="download">
<i class="icon icon-download"></i> Download
</a>
{% endif %}
</li>
<li class="repo-stars">
<a href="{{ repo_url }}/stargazers" target="_blank" title="Stargazers" data-action="star">

2
material/header.html
View File

@@ -44,7 +44,7 @@
</div>
<div class="stretch">
<div class="field">
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false">
</div>
</div>
<div class="button button-reset" role="button" aria-label="Search">

8
material/manifest.json
View File

@@ -1,7 +1,7 @@
{
"assets/images/favicon.ico": "assets/images/favicon-e565ddfa3b.ico",
"assets/javascripts/application.js": "assets/javascripts/application-997097ee0c.js",
"assets/javascripts/modernizr.js": "assets/javascripts/modernizr-4ab42b99fd.js",
"assets/stylesheets/application.css": "assets/stylesheets/application-a422ff04cc.css",
"assets/stylesheets/palettes.css": "assets/stylesheets/palettes-05ab2406df.css"
"assets/javascripts/application.js": "assets/javascripts/application-82b5011116.js",
"assets/javascripts/modernizr.js": "assets/javascripts/modernizr-2216498cab.js",
"assets/stylesheets/application.css": "assets/stylesheets/application-e576885f03.css",
"assets/stylesheets/palettes.css": "assets/stylesheets/palettes-2d6c5d2926.css"
}

2
mkdocs.yml
View File

@@ -38,6 +38,8 @@ theme_dir: material
extra:
version: 0.2.4
logo: images/logo.png
github:
download_release: true
author:
github: squidfunk
twitter: squidfunk

18
src/drawer.html
View File

@@ -41,11 +41,19 @@
{% if repo_name == "GitHub" and repo_url %}
<ul class="repo">
<li class="repo-download">
{% set version = config.extra.version | default("master") %}
<a href="{{ repo_url }}/archive/{{ version }}.zip" target="_blank"
title="Download" data-action="download">
<i class="icon icon-download"></i> Download
</a>
{% if config.extra.github and config.extra.github.download_release %}
{% set version = config.extra.version | default("../latest") %}
<a href="{{ repo_url }}/releases/tag/{{ version }}" target="_blank"
title="Download" data-action="download">
<i class="icon icon-download"></i> Download
</a>
{% else %}
{% set version = config.extra.version | default("master") %}
<a href="{{ repo_url }}/archive/{{ version }}.zip" target="_blank"
title="Download" data-action="download">
<i class="icon icon-download"></i> Download
</a>
{% endif %}
</li>
<li class="repo-stars">
<a href="{{ repo_url }}/stargazers" target="_blank"