Narzędzia Docs Demo¶
Lista kontrolna motywów¶
To demo zostało zaprojektowane w celu przetestowania różnych funkcji motywu BeeWare MkDocs Material. Proszę przeczytać i sprawdzić, czy wszystko, co jest wymienione na tej i kolejnych stronach, jest obecne i działa zgodnie z opisem.
Pasek tytułu¶
Na stronie znajduje się średnio szary pasek tytułu. Zastosowano szablon motywu.
Ikona nagłówka¶
Ikona nagłówka w lewym górnym rogu została wyrenderowana. Potwierdza to, że szablon może odwoływać się do zasobów zewnętrznych.
Ikona paska bocznego strony głównej¶
Ikona logo w lewym pasku bocznym została wyrenderowana. Logo powinno mieć taką samą szerokość i wysokość jak pasek boczny. Tytuł strony powinien być wyrenderowany poniżej niego nieco większą czcionką niż reszta paska bocznego, a numer wersji poniżej niego mniejszą czcionką.
Potwierdza to, że pasek boczny będzie wyświetlany poprawnie na docelowych stronach.
Czcionka nagłówka¶
Nagłówki są renderowane w Cutive. Potwierdza to, że zastosowano niestandardowy motyw CSS BeeWare.
Kod wbudowany¶
Kod wbudowany jest renderowany w tym samym kolorze co otaczająca go czcionka. Potwierdza to, że motyw nie spowodował żadnych niepożądanych zmian.
To jest tekst z inline code tutaj i inline code tutaj.
Kod treści z zakładkami¶
Kod ma kolor kontrastujący z tłem. Przycisk kopiowania powinien kopiować tylko polecenia; nie powinien zawierać znaku zachęty.
Potwierdza to, że motyw nie spowodował żadnych niepożądanych zmian, a także czy przycisk kopiowania działa zgodnie z oczekiwaniami.
$ 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
Zachowanie przycisku kopiowania kodu¶
Przycisk kopiowania w poniższym bloku kodu powinien spowodować skopiowanie from
pathlib import Path do schowka.
from pathlib import Path
Przycisk kopiowania w poniższym bloku kodu powinien spowodować skopiowanie ls
beeware-docs-tools do schowka. Nie należy uwzględniać wiersza poleceń powłoki
ani wyników.
(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt tox.ini
docs pyproject.toml requirements.docs.txt
LICENSE README.md src
Linki w pasku bocznym¶
Istnieją linki w pasku bocznym, które kierują do repozytorium
beeware-docs-tools. Potwierdza to, że zawartość paska bocznego została
załadowana, a project-name zostało ustawione w pliku konfiguracyjnym MkDocs, a
numer wersji został obliczony i dodany.
Kolory linków¶
Ten link do głównej strony BeeWare powinien być niebieski zarówno w trybie jasnym, jak i ciemnym.
Linki w lewym i prawym pasku bocznym powinny być również niebieskie w obu trybach.
Podczas przewijania strony aktywny link nagłówka w prawym pasku bocznym powinien mieć kolor jasnoniebieski w trybie ciemnym i ciemnoniebieski w trybie jasnym.
Przestroga dotycząca tłumaczenia¶
W angielskiej wersji tego dokumentu powinno pojawić się poniższe ostrzeżenie „Dostępne są tłumaczenia”. W tłumaczeniu na język francuski powinno pojawić się ostrzeżenie „To jest tłumaczenie maszynowe!”. W tłumaczeniu na język niemiecki powinno pojawić się ostrzeżenie „To jest tłumaczenie!” dotyczące tłumaczeń wykonywanych przez ludzi.
To jest tłumaczenie maszynowe!
Ta wersja samouczka została wygenerowana przez tłumaczenie maszynowe. Wiemy, że nie jest to idealne rozwiązanie, ale uznaliśmy, że złe tłumaczenie jest lepsze niż brak tłumaczenia.
Niestandardowa strona 404¶
Dodaj nopage na końcu adresu URL w przeglądarce, aby sprawdzić, czy strona 404
istnieje i zawiera tekst „Brutus nie może znaleźć tego, czego szukasz”. Obecna
strona 404 nie zawsze wyświetla obrazy z powodu problemu z MkDocs.
Kompilacja MkDocs kończy się niepowodzeniem w przypadku nierozpoznanych linków wewnętrznych, dlatego należy ręcznie zweryfikować to sprawdzenie, modyfikując adres URL w przeglądarce.
Kolejne kontrole¶
Poniższy link powinien przekierować Cię do sekcji pierwszej demonstracji narzędzi BeeWare Docs. Został on dodany w celu sprawdzenia działania linków między stronami.
Przejdź do BeeWare Docs Tools Demo Section One, aby przejść do kolejnych sprawdzeń.