پرش به محتویات

محیط آزمون محتوای مشترک

این بخش برای تأیید محتوای مشترک ارائه‌شده از این مخزن جهت استفاده در سایر مستندات BeeWare گنجانده شده است. «محتوای مشترک» به اسناد یا بخش‌هایی از اسناد اطلاق می‌شود که در چندین مخزن دیگر مشترک هستند. این موارد در اینجا ذخیره می‌شوند تا در تمامی آن مخازن گنجانده شوند. این بدان معناست که هنگام نیاز به به‌روزرسانی، یک منبع واحد وجود دارد و آن تغییر در تمامی مخازن استفادهکننده از آن محتوای مشترک اعمال خواهد شد.

اگر در حال به‌روزرسانی محتوای موجود هستید، مراحل زیر ضروری نیستند. می‌توانید به‌سادگی سایت آزمایشی را بسازید و به‌روزرسانی‌های خود را مشاهده کنید.

اگر در حال ایجاد یک فایل مستندسازی مشترک جدید در دایرکتوری shared-content هستید که قرار نیست در دایرکتوری how-to گنجانده شود، موارد زیر را انجام دهید:

  1. در content_test_bed فایلی با همان نام فایل محتوای جدیدتان ایجاد کنید و «_include» را به انتهای آن اضافه کنید.
    • برای style_guide.md، شما style_guide_include.md را اضافه می‌کنید.
  2. با استفاده از سینتکس Snippets، نام فایل را در filename_include.md قرار دهید. سینتکس Snippets برای درج محتوا عبارت -8<- "filename.md" است.
    • برای style_guide.md، شما -8<- "style_guide.md" را به style_guide_include.md اضافه می‌کنید.
  3. بخش Shared content test bed را در /docs/SUMMARY.md به‌روزرسانی کنید تا فایل و مسیر جدید _include را شامل شود و هم‌سطح با سایر موارد در آن بخش باشد.
    • برای style_guide_include.md، شما - [Style guide](content_test_bed/style_guide_include.md) را اضافه می‌کنید.

پس از تکمیل این مراحل، می‌توانید سایت تست را بسازید و مستندات جدیدتان را مشاهده کنید.