Skip to content

Commit 18a3e00

Browse files
Andre601Andre601
committed
Improve API page and header
1 parent 7cd257b commit 18a3e00

File tree

5 files changed

+42
-35
lines changed

5 files changed

+42
-35
lines changed

‎docs/assets/css/styling/admonitions.css

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
:root {
22
--md-admonition-icon--youtube: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"/></svg>');
3+
--md-admonition-icon--not_translatable: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>translate-off</title><path d="M12.17,5.81C11.87,6.69 11.47,7.55 11,8.39L12.35,9.74C13.11,8.5 13.71,7.18 14.13,5.81H17.16V3.75H9.94V1.69H7.87V3.75H6.37L8.43,5.81H12.17M15.53,12.91L17.03,14.41L17.67,12.69L19.08,16.47L22.39,19.77L18.7,9.94H16.64L15.53,12.91M1.31,1.31L0,2.62L1.13,3.75H0.65V5.81H3.19L5.26,7.88H4.46C5.21,9.56 6.24,11.15 7.53,12.58L2.28,17.76L3.75,19.22L8.91,14.07L12.11,17.27L12.8,15.43L14.1,16.72L12,22.31H14.06L15.22,19.22H16.6L21.38,24L22.69,22.69L1.31,1.31Z" /></svg>');
4+
--md-admonition-icon--translate: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>translate</title><path d="M12.87,15.07L10.33,12.56L10.36,12.53C12.1,10.59 13.34,8.36 14.07,6H17V4H10V2H8V4H1V6H12.17C11.5,7.92 10.44,9.75 9,11.35C8.07,10.32 7.3,9.19 6.69,8H4.69C5.42,9.63 6.42,11.17 7.67,12.56L2.58,17.58L4,19L9,14L12.11,17.11L12.87,15.07M18.5,10H16.5L12,22H14L15.12,19H19.87L21,22H23L18.5,10M15.88,17L17.5,12.67L19.12,17H15.88Z" /></svg>');
35

46
--md-clipboard-icon: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path fill-rule="evenodd" d="M2 9.75C2 8.784 2.784 8 3.75 8h2.5a.75.75 0 010 1.5h-2.5a.25.25 0 00-.25.25v10.5c0 .138.112.25.25.25h10.5a.25.25 0 00.25-.25v-2.5a.75.75 0 011.5 0v2.5A1.75 1.75 0 0114.25 22H3.75A1.75 1.75 0 012 20.25V9.75z"></path><path fill-rule="evenodd" d="M8 3.75C8 2.784 8.784 2 9.75 2h10.5c.966 0 1.75.784 1.75 1.75v10.5A1.75 1.75 0 0120.25 16H9.75A1.75 1.75 0 018 14.25V3.75zm1.75-.25a.25.25 0 00-.25.25v10.5c0 .138.112.25.25.25h10.5a.25.25 0 00.25-.25V3.75a.25.25 0 00-.25-.25H9.75z"></path></svg>');
57
}
@@ -91,3 +93,33 @@
9193
font-size: .7rem;
9294
padding-left: .5rem;
9395
}
96+
97+
.md-typeset .admonition.not_translatable,
98+
.md-typeset details.not_translatable {
99+
border-color: #ff9100;
100+
}
101+
.md-typeset .not_translatable > .admonition-title,
102+
.md-typeset .not_translatable > summary {
103+
background-color: #ff91001a;
104+
}
105+
.md-typeset .not_translatable > .admonition-title::before,
106+
.md-typeset .not_translatable > summary::before {
107+
background-color: #ff9100;
108+
-webkit-mask-image: var(--md-admonition-icon--not_translatable);
109+
mask-image: var(--md-admonition-icon--not_translatable);
110+
}
111+
112+
.md-typeset .admonition.translate,
113+
.md-typeset details.translate {
114+
border-color: #00c853;
115+
}
116+
.md-typeset .translate > .admonition-title,
117+
.md-typeset .translate > summary {
118+
background-color: #00c8531a;
119+
}
120+
.md-typeset .translate > .admonition-title::before,
121+
.md-typeset .translate > summary::before {
122+
background-color: #00c853;
123+
-webkit-mask-image: var(--md-admonition-icon--translate);
124+
mask-image: var(--md-admonition-icon--translate);
125+
}

‎docs/assets/css/styling/padding.css

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,6 @@
1919
margin: 0 auto;
2020
}
2121

22-
.announcement-translation {
23-
margin: .5em auto;
24-
display: table;
25-
color: #64dd17;
26-
border: 1px solid #64dd17;
27-
border-radius: .01rem;
28-
background-color: #64dd171a;
29-
padding: .2rem;
30-
}
31-
32-
.announcement-translation.announcement-translation__not-translatable {
33-
color: #ff9100;
34-
border: 1px solid #ff9100;
35-
background-color: #ff91001a;
36-
}
37-
3822
.md-select button img.twemoji {
3923
height: 1.2rem;
4024
vertical-align: middle;

‎docs/de_CH/credits/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Diese Seite zeigt verschiedene Credits für all die unterschiedlichen Dinge welc
88
## Verwendete Bibliotheken { #used-libraries-and-utilities }
99

1010
### Bot
11-
Dank gilt den folgenden Leuten, welche Ihre Bibliothek bereitstellen, welche von \*Purr\* verwendet werden:
11+
Dank gilt den folgenden Personen/Gruppen, welche Ihre Bibliothek bereitstellen, welche von \*Purr\* verwendet werden:
1212

1313
| Bibliothek | Lizenz | Verwendet für |
1414
|-----------------------------------|------------|---------------------------------------------------------------|
@@ -20,12 +20,11 @@ Dank gilt den folgenden Leuten, welche Ihre Bibliothek bereitstellen, welche von
2020
| @rethinkdb/rethinkdb | Apache 2.0 | Datenbank handhaben. |
2121

2222
### Wiki
23-
Dank gilt den folgenden Personsn, welche Software bereitstellen, welche diese Dokumentation möglich machen!
23+
Dank gilt den folgenden Personen/Gruppen, welche Software bereitstellen, welche diese Dokumentation möglich machen!
2424

2525
| Software | Lizenz | Verwendet für |
2626
|---------------------------------|--------------|------------------------------------------------|
2727
| @mkdocs/mkdocs | BSD-2-Clause | Erstellen dieser Dokumentation. |
2828
| @squidfunk/mkdocs-material | MIT | Design dieser Dokumentation. |
2929
| @facelessuser/pymdown-extension | MIT | Unzählige Erweiterungen für die Dokumentation. |
30-
| @neoteroi/mkdocs-plugins | MIT | REST-API Dokumentation. |
3130
| @ultrabug/mkdocs-static-i18n | MIT | Übersetzungen der Dokumentation |

‎theme/.hooks/theme/views_mkdocs/layout.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<div class="admonition info">
2+
<p class="admonition-title">The content of this page has been <a href="https://github.com/purrbot-site/Docs/blob/master/docs/assets/imageapi.json" target="_blank" rel="nofollow">auto-generated from an OpenAPI file</a>.</p>
3+
</div>
4+
15
{% include "partial/info.html" %}
26

37
{%- if servers %}

‎theme/main.html

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,23 +44,11 @@
4444

4545
{% block announce %}
4646
{% if page.meta and i18n_page_locale != "en" and i18n_file_locale != i18n_page_locale %}
47-
{% set announcement_classes = "announcement-translation" %}
48-
{% if page.meta.not_translatable %}
49-
{% set announcement_classes = announcement_classes ~ " announcement-translation__not-translatable" %}
50-
{% endif %}
47+
{% set type = "not_translatable" if page.meta.not_translatable else "translate" %}
48+
{% set text = config.extra.translate.not_translatable if page.meta.not_translatable else config.translate.missing_translation | d('Error: Missing text') %}
5149

52-
<div class="{{ announcement_classes }}">
53-
{% if page.meta.not_translatable %}
54-
<span class="twemoji">
55-
{% include ".icons/material/translate-off.svg" %}
56-
</span>
57-
{{ config.extra.translate.not_translatable | d('This page cannot be translated and is therefore only available in English.') }}
58-
{% else %}
59-
<span class="twemoji">
60-
{% include ".icons/material/translate.svg" %}
61-
</span>
62-
{{ config.extra.translate.missing_translation | d('This page has not yet been translated.') }}
63-
{% endif%}
50+
<div class="admonition {{ type }}">
51+
<p class="admonition-title" style="text-align: center;">{{ text }}</p>
6452
</div>
6553
{% endif %}
6654
{% endblock %}

0 commit comments

Comments
 (0)