Demo Công cụ Tài liệu¶
Danh sách kiểm tra chủ đề¶
Bản demo này được thiết kế để kiểm tra các tính năng khác nhau của các tùy chỉnh giao diện BeeWare MkDocs Material. Vui lòng xem qua và xác minh rằng tất cả các nội dung được liệt kê trên trang này và các trang tiếp theo đều có sẵn và hoạt động đúng như mô tả.
Thanh tiêu đề¶
Trên trang có một thanh tiêu đề màu xám nhạt. Điều này cho thấy mẫu giao diện đã được áp dụng.
Biểu tượng tiêu đề¶
Biểu tượng ở góc trên bên trái đã được hiển thị. Điều này chứng tỏ mẫu có thể tham chiếu đến các tài nguyên bên ngoài.
Biểu tượng thanh bên trang chủ¶
Biểu tượng logo ở thanh bên trái đã được hiển thị. Logo phải có chiều rộng và chiều cao bằng với thanh bên. Tiêu đề trang web phải được hiển thị bên dưới logo bằng phông chữ lớn hơn một chút so với phần còn lại của thanh bên, với số phiên bản được hiển thị bên dưới bằng phông chữ nhỏ hơn.
Điều này xác nhận rằng thanh bên sẽ hiển thị đúng trên các trang web đích.
Phông chữ tiêu đề¶
Các tiêu đề được hiển thị bằng phông chữ Cutive. Điều này xác nhận rằng chủ đề CSS tùy chỉnh BeeWare đã được áp dụng.
Mã nhúng¶
Mã nhúng được hiển thị cùng màu với phông chữ xung quanh. Điều này chứng tỏ chủ đề không gây ra bất kỳ thay đổi không mong muốn nào.
Đây là đoạn văn có inline code ở đây và inline code ở đây.
Mã nội dung có tab¶
Màu chữ phải tương phản với màu nền. Nút Sao chép chỉ nên sao chép các lệnh; không nên bao gồm dòng nhắc lệnh.
Điều này xác nhận rằng chủ đề không gây ra bất kỳ thay đổi không mong muốn nào, cũng như nút sao chép có hoạt động như mong đợi hay không.
$ 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
Hành vi của nút sao chép mã¶
Nút sao chép trên khối mã sau đây sẽ sao chép from pathlib import Path vào
khay nhớ tạm.
from pathlib import Path
Nút sao chép trên khối mã sau đây sẽ sao chép ls beeware-docs-tools vào khay
nhớ tạm. Dấu nhắc lệnh và kết quả đầu ra không được bao gồm.
(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt tox.ini
docs pyproject.toml requirements.docs.txt
LICENSE README.md src
Các liên kết ở thanh bên¶
Các liên kết trên thanh bên đã xuất hiện và trỏ đến kho lưu trữ
beeware-docs-tools. Điều này xác nhận rằng nội dung thanh bên đã được tải,
biến project-name đã được thiết lập trong tệp cấu hình MkDocs, và số phiên bản
đã được tính toán và thêm vào.
Màu sắc của liên kết¶
Liên kết này đến trang web chính của BeeWare phải có màu xanh lam trong cả chế độ sáng và chế độ tối.
Các liên kết ở thanh bên trái và bên phải cũng phải có màu xanh lam trong cả hai chế độ.
Khi cuộn xuống trang, liên kết tiêu đề đang hoạt động ở thanh bên phải nên có màu xanh nhạt trong chế độ tối và màu xanh đậm hơn trong chế độ sáng.
Lưu ý về bản dịch¶
Phiên bản tiếng Anh của tài liệu này cần hiển thị thông báo "Có bản dịch sẵn" ở phía dưới. Bản dịch tiếng Pháp cần hiển thị thông báo "Đây là bản dịch tự động!". Bản dịch tiếng Đức cần hiển thị thông báo "Đây là bản dịch!" đối với các bản dịch do con người thực hiện.
Đây là bản dịch tự động!
Phiên bản hướng dẫn này được tạo ra bằng công nghệ dịch máy. Chúng tôi biết rằng điều này chưa hoàn hảo, nhưng chúng tôi cho rằng một bản dịch chưa tốt vẫn còn hơn là không có bản dịch nào cả.
Trang 404 tùy chỉnh¶
Hãy thêm nopage vào cuối URL trong trình duyệt của bạn để kiểm tra xem trang
404 có tồn tại hay không và có hiển thị dòng chữ "Brutus không thể tìm thấy nội
dung bạn đang tìm kiếm" hay không. Trang 404 hiện tại không phải lúc nào cũng
hiển thị hình ảnh do một sự cố với MkDocs.
Quá trình biên dịch MkDocs sẽ thất bại do có các liên kết nội bộ không được nhận diện, vì vậy bạn cần kiểm tra lại thủ công bằng cách chỉnh sửa URL trong trình duyệt của mình.
Các lần kiểm tra tiếp theo¶
Liên kết sau đây sẽ đưa bạn đến Phần 1 của Bản demo Công cụ BeeWare Docs. Liên kết này được đưa vào để kiểm tra tính năng liên kết giữa các trang.
Hãy truy cập Phần 1 của Bản demo Công cụ Tài liệu BeeWare để thực hiện các bước kiểm tra tiếp theo.