BeeWare Docs Tools Demo¶
Themen-Checkliste¶
Diese Demo wurde entwickelt, um die verschiedenen Funktionen der BeeWare MkDocs Material-Themenüberschreibungen zu testen. Bitte lesen Sie sie durch und überprüfen Sie, ob alles, was auf dieser und den folgenden Seiten aufgeführt ist, vorhanden ist und wie in der Beschreibung beschrieben funktioniert.
Titelleiste¶
Eine mittelgraue Titelleiste befindet sich auf der Seite. Hier wurde die Themenvorlage angewendet.
Kopfzeilen-Symbol¶
Das Kopfzeilensymbol oben links wurde gerendert. Dies bestätigt, dass die Vorlage auf externe Ressourcen verweisen kann.
Symbol für die Seitenleiste der Homepage¶
Das Logo-Symbol in der linken Seitenleiste wurde gerendert. Das Logo sollte die gleiche Breite und Höhe haben wie die Seitenleiste. Der Titel der Website sollte darunter in etwas größerer Schrift als der Rest der Seitenleiste dargestellt werden, die Versionsnummer darunter in kleinerer Schrift.
Damit wird bestätigt, dass die Seitenleiste auf den Zielseiten korrekt dargestellt wird.
Schriftart der Überschrift¶
Überschriften werden in Cutive gerendert. Dies bestätigt, dass das benutzerdefinierte CSS-Thema von BeeWare angewendet wurde.
Inline-Code¶
Inline-Code wird in der gleichen Farbe wie die umgebende Schrift dargestellt. Dies bestätigt, dass das Thema keine unerwünschten Änderungen verursacht hat.
Dies ist Text mit inline code hier und inline code hier.
Code für Registerkarteninhalte¶
Der Code ist in einer zum Hintergrund kontrastierenden Farbe gehalten. Die Schaltfläche Kopieren sollte nur die Befehle kopieren; die Eingabeaufforderung sollte nicht enthalten sein.
Dadurch wird bestätigt, dass das Thema keine unerwünschten Änderungen verursacht hat und dass die Kopierschaltfläche wie erwartet funktioniert.
$ git clone https://github.com/beeware/beeware-theme.git
$ git clone https://github.com/beeware/beeware-theme.git
C:\...>git clone https://github.com/beeware/beeware-theme.git
Verhalten der Schaltfläche zum Kopieren von Code¶
Die Schaltfläche "Kopieren" im folgenden Codeblock sollte dazu führen, dass "from pathlib import Path" in die Zwischenablage kopiert wird.
from pathlib import Path
Die Kopierschaltfläche des folgenden Codeblocks sollte dazu führen, dass ls
beeware-docs-tools in die Zwischenablage kopiert wird. Der Shell-Prompt und die
Ausgabe sollten nicht enthalten sein.
(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt tox.ini
docs pyproject.toml requirements.docs.txt
LICENSE README.md src
Links in der Seitenleiste¶
Sidebar-Links sind vorhanden und verweisen auf das "beeware-docs-tools"-Repositorium. Dies bestätigt, dass der Inhalt der Seitenleiste geladen wurde und der "Projektname" in der MkDocs-Konfigurationsdatei gesetzt wurde, und die Versionsnummer wird berechnet und hinzugefügt.
Link Farben¶
Dieser Link zu der Haupt-Website von BeeWare sollte sowohl im hellen als auch im dunklen Modus blau sein.
Die Links in der linken und rechten Seitenleiste sollten in beiden Modi ebenfalls blau sein.
Wenn Sie auf der Seite nach unten scrollen, sollte der aktive Header-Link in der rechten Seitenleiste im dunklen Modus hellblau und im hellen Modus dunkler blau sein.
Übersetzung Ermahnung¶
Die englischsprachige Version dieses Dokuments sollte den Hinweis "Translations are available" anzeigen. Die französische Übersetzung sollte den Hinweis "Dies ist eine maschinelle Übersetzung" enthalten. Die deutsche Übersetzung sollte den Hinweis "Dies ist eine Übersetzung" für menschliche Übersetzungen enthalten.
Dies ist eine Übersetzung!
Dieses Dokument ist eine Übersetzung der englischen Version. Die Übersetzung wurde von Menschen überprüft, aber neuere Abschnitte können durch maschinelle Übersetzung erzeugt oder überhaupt nicht übersetzt worden sein.
Benutzerdefinierte 404-Seite¶
Fügen Sie nopage am Ende der URL in Ihrem Browser ein, um zu überprüfen, ob
die 404-Seite existiert und den Text "Brutus kann nicht finden, wonach Sie
suchen" enthält. Die aktuelle 404-Seite zeigt die Bilder aufgrund eines Problems
mit MkDocs nicht immer an.
*MkDocs-Builds schlagen bei nicht erkannten internen Links fehl, so dass Sie diese Prüfung manuell überprüfen müssen, indem Sie die URL in Ihrem Browser ändern.
Nächste Kontrollen¶
Der folgende Link sollte Sie zu BeeWare Docs Tools Demo Section One führen. Er dient der Überprüfung der seitenübergreifenden Verlinkung.
Navigieren Sie zu BeeWare Docs Tools Demo Section One für die nächsten Prüfungen.