Демонстрація інструментів Docs¶

Перелік питань за темою¶

Ця демонстраційна версія призначена для тестування різних функцій налаштувань теми «Material» для BeeWare MkDocs. Будь ласка, ознайомтеся з нею та переконайтеся, що все, що зазначено на цій та наступних сторінках, присутнє та працює відповідно до опису.

Заголовок¶

На сторінці відображається панель заголовка середньо-сірого кольору. Це означає, що застосовано шаблон теми.

Піктограма заголовка¶

Зображення-піктограма у верхньому лівому куті заголовка відобразилося. Це підтверджує, що шаблон може посилатися на зовнішні ресурси.

Піктограма бічної панелі на головній сторінці¶

У лівій бічній панелі відображено піктограму логотипу. Логотип повинен мати таку саму ширину та висоту, як і бічна панель. Назва сайту має відображатися під ним шрифтом, трохи більшим за решту тексту бічної панелі, а номер версії — під нею шрифтом меншого розміру.

Це підтверджує, що бічна панель відображатиметься належним чином на цільових сайтах.

Шрифт заголовка¶

Заголовки відображаються шрифтом Cutive. Це підтверджує, що застосовано власну CSS-тему BeeWare.

Вбудований код¶

Вбудований код відображається тим самим кольором, що й навколишній шрифт. Це підтверджує, що тема не спричинила жодних небажаних змін.

Це текст, у якому тут є inline code, а тут — inline code.

Код вмісту з вкладками¶

Код виділено кольором, що контрастує з фоном. Кнопка «Копіювати» повинна копіювати лише команди; рядок команд не слід включати.

Це дозволяє переконатися, що тема не спричинила жодних небажаних змін, а також перевірити, чи працює кнопка копіювання належним чином.

macOSLinuxWindows

$ 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

Поведінка кнопки «Копіювати код»¶

Натискання кнопки «Копіювати» у наведеному нижче блоці коду має призвести до копіювання символів from pathlib import Path у буфер обміну.

from pathlib import Path

Натискання кнопки «Копіювати» у наведеному нижче блоці коду має призвести до копіювання ls beeware-docs-tools у буфер обміну. Командний рядок оболонки та вихідні дані не повинні бути включені.

(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt  tox.ini
docs pyproject.toml    requirements.docs.txt
LICENSE README.md    src

Посилання у бічній панелі¶

Посилання в бічній панелі існують і ведуть до репозиторію beeware-docs-tools. Це підтверджує, що вміст бічної панелі завантажено, у файлі конфігурації MkDocs встановлено значення project-name, а номер версії обчислено та додано.

Кольори посилань¶

Це посилання на головний веб-сайт BeeWare має бути синім як у світлому, так і в темному режимі. Це посилання з INCLUDES CODE розміткою має мати синій колір із затіненим фоном для вмісту коду.

Посилання в лівому та правому бічних панелях також повинні бути синього кольору в обох режимах.

Під час прокручування сторінки вниз активне посилання в заголовку на правій бічній панелі має бути світло-блакитним у темному режимі та темно-блакитним у світлому режимі.

Застереження щодо перекладу¶

В англомовній версії цього документа має бути розміщено нагадування «Доступні переклади», наведене нижче. У французькому перекладі має бути розміщено нагадування «Це машинний переклад!». У німецькому перекладі, виконаному людиною, має бути розміщено нагадування «Це переклад!».

Це машинний переклад!

Ця версія посібника була створена за допомогою машинного перекладу. Ми розуміємо, що це не ідеальний варіант, але вважаємо, що навіть неякісний переклад краще, ніж його повна відсутність.

Налаштована сторінка 404¶

Додайте nopage в кінець URL-адреси у вашому браузері, щоб переконатися, що сторінка 404 існує і містить текст «Brutus не може знайти те, що ви шукаєте». Наразі на сторінці 404 зображення не завжди відображаються через проблему з MkDocs.

Збірка MkDocs завершується з помилкою через невизнані внутрішні посилання, тому вам потрібно вручну перевірити це, змінивши URL-адресу у своєму браузері.

Наступні перевірки¶

За цим посиланням ви перейдете до першого розділу демонстрації інструментів BeeWare Docs. Воно наведено для перевірки роботи міжсторінкових посилань.

Перейдіть до розділу BeeWare Docs Tools Demo Section One, щоб виконати наступні перевірки.