diff --git a/CHANGELOG b/CHANGELOG index 5daa2e7672e9414613d24c4b131bcd07b1e65007..003129891e0fc880d7519c9f55d0af4485559a0e 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 ddcc35683485e6c1dd84a3b1ebcc454279ad1eda..9a13ac5fa0d2262e1a7fba982a22a7a68d282258 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 6a5c6d1a72e9dd5194bb2b0d79a5da81b217ffe5..7eb35c5ec3bf236d74e55f777b7faf1c76d1ba93 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 4ac1955797bbab01648fca29ef0052fbc4625844..e615ae62b19ef9820c57e03bcd6a4a6129dfa32e 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 4abd3f5e52f821ec4b2e02a8360a31b2179cf84d..accc27b5e2e2629f0bc5beb19105d84d5a2518e5 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 994d4dc833a77c504ba4ad491b447af536befcdb..6eb5cb8adfadbef6b7136bfe9b58b2800628ec32 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 22ce36a22d690696f26383c938ca865d5d5306f4..2789835db111f5a3530fb916722882cb70dc6b08 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",