From b86463757f927e89481766e5151256bae7759810 Mon Sep 17 00:00:00 2001
From: squidfunk <martin.donath@squidfunk.com>
Date: Sat, 13 Jan 2018 17:19:07 +0100
Subject: [PATCH] Prepare 2.5.0 release
---
CHANGELOG | 4 ++++
README.md | 4 ++--
docs/getting-started.md | 18 +++++++++++++++++-
docs/index.md | 4 ++--
docs/release-notes.md | 6 +++++-
material/base.html | 2 +-
package.json | 2 +-
7 files changed, 32 insertions(+), 8 deletions(-)
diff --git a/CHANGELOG b/CHANGELOG
index 5daa2e76..00312989 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -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
diff --git a/README.md b/README.md
index ddcc3568..9a13ac5f 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 6a5c6d1a..7eb35c5e 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -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`
diff --git a/docs/index.md b/docs/index.md
index 4ac19557..e615ae62 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -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
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 4abd3f5e..accc27b5 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -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
diff --git a/material/base.html b/material/base.html
index 994d4dc8..6eb5cb8a 100644
--- a/material/base.html
+++ b/material/base.html
@@ -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 %}
diff --git a/package.json b/package.json
index 22ce36a2..2789835d 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "mkdocs-material",
- "version": "2.4.0",
+ "version": "2.5.0",
"description": "A Material Design theme for MkDocs",
"keywords": [
"mkdocs",
--
GitLab