1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-24 07:30:12 +01:00

Prepare 0.1.2 release

This commit is contained in:
squidfunk 2016-02-16 17:04:03 +01:00
parent 075d144ca1
commit e1cf87b483
8 changed files with 19 additions and 13 deletions

View File

@ -1,4 +1,4 @@
mkdocs-material-0.x.x (2016-xx-xx) mkdocs-material-0.1.2 (2016-02-16)
* Fixed styles for deep navigational hierarchies * Fixed styles for deep navigational hierarchies
* Fixed webfont delivery problem when hosted in subdirectories * Fixed webfont delivery problem when hosted in subdirectories

View File

@ -1,6 +1,6 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "0.1.1", "version": "0.1.2",
"description": "A material design theme for MkDocs", "description": "A material design theme for MkDocs",
"homepage": "http://squidfunk.github.io/mkdocs-material/", "homepage": "http://squidfunk.github.io/mkdocs-material/",
"authors": [ "authors": [

View File

@ -116,7 +116,8 @@ extra:
If you want to change the fonts or colors - you are lucky. The Material theme If you want to change the fonts or colors - you are lucky. The Material theme
is built with a sophisticated asset pipeline. See is built with a sophisticated asset pipeline. See
[this article](/customization) for more information on advanced customization. [this article](customization.md) for more information on advanced
customization.
## Extensions ## Extensions
@ -174,8 +175,13 @@ This will print the following:
!!! note !!! note
Nothing to see here, move along. Nothing to see here, move along.
The Material template adds a light color for the `note` class and a red color The Material template adds a neutral color for the `note` class and a red color
for the `warning` class. More colors can be freely defined. for the `warning` class.
!!! warning
You shall not pass.
More colors can be freely defined.
## Full example ## Full example
@ -186,7 +192,7 @@ Below is a full example configuration for a mkdocs.yml:
site_name: 'My Project' site_name: 'My Project'
site_description: 'A short description of my project' site_description: 'A short description of my project'
site_author: 'John Doe' site_author: 'John Doe'
site_url: 'https://github.com/my-github-handle/my-project' site_url: 'https://my-github-handle.github.io/my-project'
# Repository # Repository
repo_name: 'GitHub' repo_name: 'GitHub'

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.7 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

@ -7,7 +7,7 @@ Google's [material design][] guidelines. MkDocs is an excellent static site
documentation generator that is meant for building good looking project documentation generator that is meant for building good looking project
documentation. documentation.
![Material Screenshot](/images/screen.png) ![Material Screenshot](images/screen.png)
This theme is **optimized for all sorts of devices** and is built from scratch This theme is **optimized for all sorts of devices** and is built from scratch
without any bloated Javascript or CSS Frameworks with **only 24kb of JS and without any bloated Javascript or CSS Frameworks with **only 24kb of JS and
@ -24,8 +24,8 @@ browsers.
- Well-tested and **optimized CSS and Javascript**, including a cross-browser - Well-tested and **optimized CSS and Javascript**, including a cross-browser
fixed/sticky header, a drawer that even works without Javascript using fixed/sticky header, a drawer that even works without Javascript using
the `checkbox:checked` hack with fallbacks, **responsive tables** that scroll the `:checked` hack with fallbacks, **responsive tables** that scroll when
when the screen is too small and **well-defined print styles**. the screen is too small and **well-defined print styles**.
- Extra configuration options like **project logo**, links to the authors - Extra configuration options like **project logo**, links to the authors
**GitHub and Twitter accounts** and display of the **amount of stars** the **GitHub and Twitter accounts** and display of the **amount of stars** the
@ -38,7 +38,7 @@ browsers.
- **Web application capability** on iOS - when the page is saved to the - **Web application capability** on iOS - when the page is saved to the
homescreen, it behaves and looks like a native application. homescreen, it behaves and looks like a native application.
See the [getting started guide](/getting-started) for instructions how to get See the [getting started guide](getting-started.md) for instructions how to get
it up and running. it up and running.
[material design]: https://www.google.com/design/spec/material-design [material design]: https://www.google.com/design/spec/material-design

View File

@ -36,7 +36,7 @@ theme_dir: material
# Options # Options
extra: extra:
version: 0.1.1 version: 0.1.2
logo: images/logo.png logo: images/logo.png
font: font:
text: Ubuntu text: Ubuntu

View File

@ -1,6 +1,6 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "0.1.1", "version": "0.1.2",
"description": "A material design theme for MkDocs", "description": "A material design theme for MkDocs",
"homepage": "http://squidfunk.github.io/mkdocs-material/", "homepage": "http://squidfunk.github.io/mkdocs-material/",
"authors": [ "authors": [

View File

@ -23,7 +23,7 @@ from setuptools import setup, find_packages
# Package description # Package description
setup( setup(
name = 'mkdocs-material', name = 'mkdocs-material',
version = '0.1.1', version = '0.1.2',
url = 'http://squidfunk.github.io/mkdocs-material/', url = 'http://squidfunk.github.io/mkdocs-material/',
license = 'MIT', license = 'MIT',
description = 'A material design theme for MkDocs', description = 'A material design theme for MkDocs',