Belgeler Araçları Demosu¶
Tema kontrol listesi¶
Bu demo, BeeWare MkDocs Material tema geçersiz kılmalarının çeşitli özelliklerini test etmek için tasarlanmıştır. Lütfen bu sayfayı ve sonraki sayfaları baştan sona okuyun ve burada ve sonraki sayfalarda listelenen her şeyin mevcut olduğunu ve açıklamada belirtildiği gibi çalıştığını doğrulayın.
Başlık çubuğu¶
Sayfada orta gri renkli bir başlık çubuğu bulunmaktadır. Bu tema şablonu uygulanmıştır.
Başlık simgesi¶
Sol üst köşedeki başlık simgesi görüntülenmiştir. Bu, şablonun harici kaynaklara başvurabileceğini doğrular.
Ana sayfa kenar çubuğu simgesi¶
Sol kenar çubuğundaki logo simgesi görüntülenmiştir. Logo, kenar çubuğunun genişliği ve yüksekliği ile aynı olmalıdır. Site başlığı, kenar çubuğunun geri kalanından biraz daha büyük bir yazı tipiyle logo simgesinin altında, sürüm numarası ise daha küçük bir yazı tipiyle logo simgesinin altında görüntülenmelidir.
Bu, kenar çubuğunun hedef sitelerde düzgün bir şekilde görüntüleneceğini onaylar.
Başlık yazı tipi¶
Başlıklar Cutive ile görüntülenir. Bu, BeeWare özel CSS temasının uygulandığını doğrular.
Satır içi kod¶
Satır içi kod, çevresindeki yazı tipiyle aynı renkte görüntülenir. Bu, temanın istenmeyen değişikliklere neden olmadığını doğrular.
Bu, burada inline code ve burada inline code bulunan bir metindir.
Sekmeli içerik kodu¶
Kod, arka planla kontrast oluşturan bir renktedir. Kopyala düğmesi yalnızca komutları kopyalamalıdır; komut istemi dahil edilmemelidir.
Bu, temanın istenmeyen değişikliklere neden olmadığını ve kopyala düğmesinin beklendiği gibi çalıştığını doğrular.
$ 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
Kod kopyalama düğmesi davranışı¶
Aşağıdaki kod bloğundaki kopyala düğmesi, from pathlib import Path 'nin panoya
kopyalanmasını sağlamalıdır.
from pathlib import Path
Aşağıdaki kod bloğundaki kopyala düğmesi, ls beeware-docs-tools 'nin panoya
kopyalanmasını sağlamalıdır. Kabuk istemini ve çıktıyı dahil etmemelisiniz.
(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt tox.ini
docs pyproject.toml requirements.docs.txt
LICENSE README.md src
Kenar çubuğu bağlantıları¶
Kenar çubuğu bağlantıları mevcuttur ve beeware-docs-tools deposuna
yönlendirir. Bu, kenar çubuğu içeriğinin yüklendiğini, MkDocs yapılandırma
dosyasında project-name ayarlandığını ve sürüm numarasının hesaplanıp
eklendiğini doğrular.
Bağlantı renkleri¶
[BeeWare ana web sitesine] giden bu bağlantı, hem açık modda hem de koyu modda mavi olmalıdır.
Sol ve sağ kenar çubuklarındaki bağlantılar da her iki modda mavi olmalıdır.
Sayfayı aşağı kaydırırken, sağ kenar çubuğundaki etkin başlık bağlantısı karanlık modda açık mavi, açık modda ise koyu mavi olmalıdır.
Çeviri uyarısı¶
Bu belgenin İngilizce versiyonunda aşağıdaki "Çeviriler mevcuttur" uyarısı gösterilmelidir. Fransızca çeviride "Bu bir makine çevirisidir!" uyarısı gösterilmelidir. Almanca çeviride ise insan tarafından yapılan çeviriler için "Bu bir çeviridir!" uyarısı gösterilmelidir.
Bu bir makine çevirisidir!
Bu eğitim versiyonu makine çevirisi ile oluşturulmuştur. Bunun ideal olmadığını biliyoruz, ancak kötü bir çevirinin hiç çeviri olmamasından daha iyi olduğunu düşündük.
Özel 404 sayfası¶
Tarayıcınızda URL'nin sonuna nopage ekleyerek 404 sayfasının varlığını ve
"Brutus aradığınızı bulamıyor" metnini içerdiğini doğrulayın. Mevcut 404
sayfası, MkDocs ile ilgili bir sorun nedeniyle her zaman görüntüleri göstermez.
MkDocs, tanınmayan iç bağlantılar nedeniyle derleme hatası verir, bu nedenle tarayıcınızda URL'yi değiştirerek bu kontrolü manuel olarak doğrulamanız gerekir.
Sonraki kontroller¶
Aşağıdaki bağlantı sizi BeeWare Docs Tools Demo Section One sayfasına yönlendirmelidir. Bu bağlantı, sayfalar arası bağlantıları doğrulamak için eklenmiştir.
Sonraki kontroller için BeeWare Docs Tools Demo Section One bölümüne gidin.