نمایش ابزارهای مستندات¶
فهرست موضوعات¶
این دمو برای آزمایش ویژگیهای مختلف overrideهای تم Material در BeeWare MkDocs طراحی شده است. لطفاً آن را مطالعه کرده و تأیید کنید که همه موارد فهرستشده در این صفحه و صفحات بعدی موجود بوده و مطابق توضیحات کار میکنند.
سربرگ¶
یک نوار عنوان خاکستری متوسط روی صفحه قرار دارد. این قالب تم اعمال شده است.
آیکون سربرگ¶
آیکون هدر در بالای سمت چپ رندر شد. این تأیید میکند که قالب میتواند به منابع خارجی ارجاع دهد.
آیکون نوار کناری صفحهٔ اصلی¶
آیکون لوگو در نوار کناری سمت چپ نمایش داده شده است. لوگو باید به عرض نوار کناری و با ارتفاع برابر آن باشد. عنوان سایت باید در زیر آن با فونت کمی بزرگتر از سایر بخشهای نوار کناری نمایش داده شود و شماره نسخه در زیر آن با فونت کوچکتر نوشته شود.
این تأیید میکند که نوار کناری در سایتهای هدف بهدرستی نمایش داده خواهد شد.
فونت سربرگ¶
سربرگها با Cutive نمایش داده میشوند. این تأیید میکند که تم CSS سفارشی BeeWare اعمال شده است.
کد درون خطی¶
کد درونخطی با همان رنگِ فونت اطراف نمایش داده میشود. این تأیید میکند که قالب هیچ تغییر ناخواستهای ایجاد نکرده است.
این متنی است که inline code اینجا و inline code اینجا دارد.
کد محتوای تبدار¶
کد باید به رنگی متضاد با پسزمینه باشد. دکمهٔ کپی باید فقط دستورات را کپی کند؛ پرامپت نباید شامل شود.
این تأیید میکند که قالب هیچ تغییر ناخواستهای ایجاد نکرده و همچنین بررسی میکند که آیا دکمه کپی طبق انتظار کار میکند.
$ 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 به
کلیپبورد کپی شود.
از pathlib وارد 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 اشاره میکنند. این
تأیید میکند که محتوای نوار کناری بارگذاری شده است، project-name در فایل
پیکربندی MkDocs تنظیم شده است و شماره نسخه محاسبه و اضافه شده است.
رنگهای لینک¶
این لینک به وبسایت اصلی BeeWare باید در هر دو حالت روشن و تاریک آبی باشد.
لینکهای نوار کناری چپ و راست نیز باید در هر دو حالت آبی باشند.
هنگام پیمایش صفحه به پایین، لینک فعال هدر در نوار کناری سمت راست باید در حالت تاریک آبی روشن و در حالت روشن آبی تیرهتر باشد.
تذکر ترجمه¶
نسخهٔ انگلیسی این سند باید هشدار «ترجمهها در دسترس هستند» را در زیر نمایش دهد. ترجمهٔ فرانسوی باید هشدار «این یک ترجمهٔ ماشینی است!» را نمایش دهد. ترجمهٔ آلمانی باید هشدار «این یک ترجمه است!» را برای ترجمههای انسانی نمایش دهد.
این یک ترجمه ماشینی است!
این نسخه از آموزش توسط ترجمهٔ ماشینی تولید شده است. میدانیم که این ایدهآل نیست، اما احساس کردیم که یک ترجمهٔ ضعیف بهتر از هیچ ترجمهای است.
صفحهٔ ۴۰۴ سفارشی¶
در انتهای آدرس اینترنتی در مرورگر خود nopage را اضافه کنید تا مطمئن شوید صفحهٔ
خطای ۴۰۴ وجود دارد و شامل متن «بروتوس نمیتواند آنچه را که به دنبالش هستید پیدا
کند» است. صفحهٔ ۴۰۴ فعلی به دلیل مشکلی در MkDocs همیشه تصاویر را نمایش نمیدهد.
ساخت MkDocs با لینکهای داخلی ناشناخته با شکست مواجه میشود، بنابراین باید این بررسی را با تغییر آدرس URL در مرورگر خود بهصورت دستی تأیید کنید.
بررسیهای بعدی¶
لینک زیر باید شما را به بخش اول دمو ابزارهای مستندات BeeWare هدایت کند. این لینک برای تأیید پیونددهی بین صفحات گنجانده شده است.
برای بررسیهای بعدی به BeeWare Docs Tools Demo Section One بروید.