Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-30 18:24:35 +01:00
Code Issues Releases Wiki Activity

Added support for default localization and German translations

Browse Source
This commit is contained in:
squidfunk 2017-10-19 20:09:59 +02:00 committed by Martin Donath
parent 9005ae2381
commit 9f513d6411
21 changed files with 152 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG
View File

@ -1,7 +1,11 @@
master
* Fixed #374: Search bar misalignment on big screens
mkdocs-material-1.11.0 (2017-10-19) mkdocs-material-1.11.0 (2017-10-19)
* Added localization to clipboard * Added localization to clipboard
* Refactored i18n localization logic * Refactored localization logic
mkdocs-material-1.10.4 (2017-10-18) mkdocs-material-1.10.4 (2017-10-18)

4
docs/release-notes.md
View File

@ -20,7 +20,7 @@ pip show mkdocs-material | grep -E ^Version
### 1.11.0 <small>_ October 19, 2017</small> ### 1.11.0 <small>_ October 19, 2017</small>
* Added localization to clipboard * Added localization to clipboard
* Refactored i18n localization logic * Refactored localization logic
### 1.10.4 <small>_ October 18, 2017</small> ### 1.10.4 <small>_ October 18, 2017</small>
@ -28,7 +28,7 @@ pip show mkdocs-material | grep -E ^Version
* Improved search UX (don't close on enter if no selection) * Improved search UX (don't close on enter if no selection)
* Fixed [#495][495]: Vertical scrollbar on short pages * Fixed [#495][495]: Vertical scrollbar on short pages
[495]: https://github.com/squidfunk/mkdocs-material/issues/484 [495]: https://github.com/squidfunk/mkdocs-material/issues/495
### 1.10.3 <small>_ October 11, 2017</small> ### 1.10.3 <small>_ October 11, 2017</small>

2
material/assets/stylesheets/application-6062816a07.css → material/assets/stylesheets/application-04ea671600.css
View File

File diff suppressed because one or more lines are too long

4
material/base.html
View File

@ -1,4 +1,4 @@
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
<!DOCTYPE html> <!DOCTYPE html>
<html lang="{{ lang.t('language') }}" class="no-js"> <html lang="{{ lang.t('language') }}" class="no-js">
<head> <head>
@ -50,7 +50,7 @@
<script src="{{ base_url }}/assets/javascripts/modernizr-e826f8942a.js"></script> <script src="{{ base_url }}/assets/javascripts/modernizr-e826f8942a.js"></script>
{% endblock %} {% endblock %}
{% block styles %} {% block styles %}
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-6062816a07.css"> <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-04ea671600.css">
{% if config.extra.palette %} {% if config.extra.palette %}
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-23f75ab9c7.palette.css"> <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-23f75ab9c7.palette.css">
{% endif %} {% endif %}

2
material/partials/footer.html
View File

@ -1,4 +1,4 @@
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
<footer class="md-footer"> <footer class="md-footer">
{% if page.previous_page or page.next_page %} {% if page.previous_page or page.next_page %}
<div class="md-footer-nav"> <div class="md-footer-nav">

22
material/partials/language.html
View File

@ -1,19 +1,3 @@
{% macro t(key) %}{{ { {% set code = config.extra.language | default("en") %}
"language": "en", {% import "partials/language/" + code + ".html" as lang %}
"clipboard.copy": "Copy to clipboard", {% macro t(key) %}{{ lang.t(key) }}{% endmacro %}
"clipboard.copied": "Copied to clipboard",
"edit.link.title": "Edit this page",
"footer.previous": "Previous",
"footer.next": "Next",
"meta.comments": "Comments",
"meta.source": "Source",
"search.languages": "",
"search.placeholder": "Search",
"search.result.placeholder": "Type to start searching",
"search.result.none": "No matching documents",
"search.result.one": "1 matching document",
"search.result.other": "# matching documents",
"search.tokenizer": "[\s\-]+",
"source.link.title": "Go to repository",
"toc.title": "Table of contents"
}[key] }}{% endmacro %}

19
material/partials/language/de.html Normal file
View File

@ -0,0 +1,19 @@
{% macro t(key) %}{{ {
"language": "de",
"clipboard.copy": "In Zwischenablage kopieren",
"clipboard.copied": "In Zwischenablage kopiert",
"edit.link.title": "Seite editieren",
"footer.previous": "Vorherige Seite",
"footer.next": "Nächste Seite",
"meta.comments": "Kommentare",
"meta.source": "Quellcode",
"search.languages": "de",
"search.placeholder": "Suche",
"search.result.placeholder": "Suchbegriff eingeben",
"search.result.none": "Keine Suchergebnisse",
"search.result.one": "1 Suchergebnis",
"search.result.other": "# Suchergebnisse",
"search.tokenizer": "[\s\-]+",
"source.link.title": "Quellcode",
"toc.title": "Inhaltsverzeichnis"
}[key] }}{% endmacro %}

19
material/partials/language/en.html Normal file
View File

@ -0,0 +1,19 @@
{% macro t(key) %}{{ {
"language": "en",
"clipboard.copy": "Copy to clipboard",
"clipboard.copied": "Copied to clipboard",
"edit.link.title": "Edit this page",
"footer.previous": "Previous",
"footer.next": "Next",
"meta.comments": "Comments",
"meta.source": "Source",
"search.languages": "",
"search.placeholder": "Search",
"search.result.placeholder": "Type to start searching",
"search.result.none": "No matching documents",
"search.result.one": "1 matching document",
"search.result.other": "# matching documents",
"search.tokenizer": "[\s\-]+",
"source.link.title": "Go to repository",
"toc.title": "Table of contents"
}[key] }}{% endmacro %}

2
material/partials/search.html
View File

@ -1,4 +1,4 @@
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
<div class="md-search" data-md-component="search" role="dialog"> <div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="search"></label> <label class="md-search__overlay" for="search"></label>
<div class="md-search__inner"> <div class="md-search__inner">

2
material/partials/source.html
View File

@ -1,4 +1,4 @@
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
{% set platform = config.extra.repo_icon or config.repo_url %} {% set platform = config.extra.repo_icon or config.repo_url %}
{% if "github" in platform %} {% if "github" in platform %}
{% set repo_type = "github" %} {% set repo_type = "github" %}

2
material/partials/toc.html
View File

@ -1,4 +1,4 @@
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
<nav class="md-nav md-nav--secondary"> <nav class="md-nav md-nav--secondary">
{% set toc_ = page.toc %} {% set toc_ = page.toc %}
{% if toc_ | first is defined and "\x3ch1 id=" in page.content %} {% if toc_ | first is defined and "\x3ch1 id=" in page.content %}

1
mkdocs.yml
View File

@ -36,6 +36,7 @@ theme_dir: material
# Options # Options
extra: extra:
language: en
feature: feature:
tabs: false tabs: false
palette: palette:

1
src/assets/stylesheets/layout/_search.scss
View File

@ -155,6 +155,7 @@ $md-toggle__search--checked:
@include break-from-device(tablet landscape) { @include break-from-device(tablet landscape) {
position: relative; position: relative;
width: 23rem; width: 23rem;
float: right;
transition: width 0.25s cubic-bezier(0.1, 0.7, 0.1, 1); transition: width 0.25s cubic-bezier(0.1, 0.7, 0.1, 1);
} }

2
src/base.html
View File

@ -20,7 +20,7 @@
IN THE SOFTWARE. IN THE SOFTWARE.
--> -->
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
<!DOCTYPE html> <!DOCTYPE html>
<html lang="{{ lang.t('language') }}" class="no-js"> <html lang="{{ lang.t('language') }}" class="no-js">

2
src/partials/footer.html
View File

@ -20,7 +20,7 @@
IN THE SOFTWARE. IN THE SOFTWARE.
--> -->
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
<!-- Application footer --> <!-- Application footer -->
<footer class="md-footer"> <footer class="md-footer">

26
src/partials/language.html
View File

@ -20,23 +20,9 @@
IN THE SOFTWARE. IN THE SOFTWARE.
--> -->
<!-- Translations --> <!-- Import translations for given language -->
{% macro t(key) %}{{ { {% set code = config.extra.language | default("en") %}
"language": "en", {% import "partials/language/" + code + ".html" as lang %}
"clipboard.copy": "Copy to clipboard",
"clipboard.copied": "Copied to clipboard", <!-- Re-export translations -->
"edit.link.title": "Edit this page", {% macro t(key) %}{{ lang.t(key) }}{% endmacro %}
"footer.previous": "Previous",
"footer.next": "Next",
"meta.comments": "Comments",
"meta.source": "Source",
"search.languages": "",
"search.placeholder": "Search",
"search.result.placeholder": "Type to start searching",
"search.result.none": "No matching documents",
"search.result.one": "1 matching document",
"search.result.other": "# matching documents",
"search.tokenizer": "[\s\-]+",
"source.link.title": "Go to repository",
"toc.title": "Table of contents"
}[key] }}{% endmacro %}

42
src/partials/language/de.html Normal file
View File

@ -0,0 +1,42 @@
<!--
Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
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.
-->
<!-- Translations: German -->
{% macro t(key) %}{{ {
"language": "de",
"clipboard.copy": "In Zwischenablage kopieren",
"clipboard.copied": "In Zwischenablage kopiert",
"edit.link.title": "Seite editieren",
"footer.previous": "Vorherige Seite",
"footer.next": "Nächste Seite",
"meta.comments": "Kommentare",
"meta.source": "Quellcode",
"search.languages": "de",
"search.placeholder": "Suche",
"search.result.placeholder": "Suchbegriff eingeben",
"search.result.none": "Keine Suchergebnisse",
"search.result.one": "1 Suchergebnis",
"search.result.other": "# Suchergebnisse",
"search.tokenizer": "[\s\-]+",
"source.link.title": "Quellcode",
"toc.title": "Inhaltsverzeichnis"
}[key] }}{% endmacro %}

42
src/partials/language/en.html Normal file
View File

@ -0,0 +1,42 @@
<!--
Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
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.
-->
<!-- Translations: English -->
{% macro t(key) %}{{ {
"language": "en",
"clipboard.copy": "Copy to clipboard",
"clipboard.copied": "Copied to clipboard",
"edit.link.title": "Edit this page",
"footer.previous": "Previous",
"footer.next": "Next",
"meta.comments": "Comments",
"meta.source": "Source",
"search.languages": "",
"search.placeholder": "Search",
"search.result.placeholder": "Type to start searching",
"search.result.none": "No matching documents",
"search.result.one": "1 matching document",
"search.result.other": "# matching documents",
"search.tokenizer": "[\s\-]+",
"source.link.title": "Go to repository",
"toc.title": "Table of contents"
}[key] }}{% endmacro %}

2
src/partials/search.html
View File

@ -20,7 +20,7 @@
IN THE SOFTWARE. IN THE SOFTWARE.
--> -->
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
<!-- Search interface --> <!-- Search interface -->
<div class="md-search" data-md-component="search" role="dialog"> <div class="md-search" data-md-component="search" role="dialog">

2
src/partials/source.html
View File

@ -20,7 +20,7 @@
IN THE SOFTWARE. IN THE SOFTWARE.
--> -->
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
<!-- <!--
Check whether the repository is hosted on one of the supported code hosting Check whether the repository is hosted on one of the supported code hosting

2
src/partials/toc.html
View File

@ -20,7 +20,7 @@
IN THE SOFTWARE. IN THE SOFTWARE.
--> -->
{% import "partials/language.html" as lang %} {% import "partials/language.html" as lang with context %}
<!-- Table of contents --> <!-- Table of contents -->
<nav class="md-nav md-nav--secondary"> <nav class="md-nav md-nav--secondary">