1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-23 23:21:00 +01:00

Prepare 2.5.0 release

This commit is contained in:
squidfunk 2018-01-13 17:19:07 +01:00 committed by Martin Donath
parent 01c9aa5e11
commit b86463757f
7 changed files with 32 additions and 8 deletions

View File

@ -1,3 +1,7 @@
mkdocs-material-2.5.0 (2017-01-13)
* Added support for right-to-left languages
mkdocs-material-2.4.0 (2017-01-11)
* Added focus state for clipboard buttons

View File

@ -42,8 +42,8 @@ theme:
## What to expect
* Responsive design and fluid layout for all kinds of screens and devices,
designed to serve your project documentation in a user-friendly way with
optimal readability.
designed to serve your project documentation in a user-friendly way in 17
languages with optimal readability.
* Easily customizable primary and accent color, fonts, favicon and logo;
straight forward localization through theme extension; integrated with Google

View File

@ -104,9 +104,12 @@ The `mkdocs` executable is provided as an entrypoint, `serve` is the default
command. Start the development server in your project root with:
```
docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```
If you're using Windows command prompt (`cmd.exe`), substitute `${PWD}` with
`"%cd%"`.
[8]: https://hub.docker.com/r/squidfunk/mkdocs-material/
## Usage
@ -324,6 +327,19 @@ Pull Request.
[16]: https://www.w3schools.com/tags/ref_language_codes.asp
#### Text direction
> Default: `ltr`
Material supports both, left-to-right (`ltr`) and right-to-left (`rtl`) text
direction. This enables more languages like Arabic, Hebrew, Syriac and others
to be used with the theme:
```
theme:
direction: rtl
```
#### Site search
> Default: `en`

View File

@ -29,8 +29,8 @@ theme:
## What to expect
* Responsive design and fluid layout for all kinds of screens and devices,
designed to serve your project documentation in a user-friendly way with
optimal readability.
designed to serve your project documentation in a user-friendly way in 17
languages with optimal readability.
* Easily customizable primary and accent color, fonts, favicon and logo;
straight forward localization through theme extension; integrated with Google

View File

@ -12,7 +12,7 @@ To determine the currently installed version, use the following command:
``` sh
pip show mkdocs-material | grep -E ^Version
# Version 2.4.0
# Version 2.5.0
```
### Material 1.x to 2.x
@ -38,6 +38,10 @@ pip show mkdocs-material | grep -E ^Version
## Changelog
### 2.5.0 <small>_ January 13, 2018</small>
* Added support for right-to-left languages
### 2.4.0 <small>_ January 11, 2018</small>
* Added focus state for clipboard buttons

View File

@ -34,7 +34,7 @@
<meta name="lang:{{ key }}" content="{{ lang.t(key) }}">
{% endfor %}
<link rel="shortcut icon" href="{{ base_url }}/{{ config.theme.favicon }}">
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-2.4.0">
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-2.5.0">
{% endblock %}
{% block htmltitle %}
{% if page and page.meta and page.meta.title %}

View File

@ -1,6 +1,6 @@
{
"name": "mkdocs-material",
"version": "2.4.0",
"version": "2.5.0",
"description": "A Material Design theme for MkDocs",
"keywords": [
"mkdocs",