Перейти до змісту

Тестова платформа для спільного контенту

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

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

Якщо ви створюєте новий файл спільної документації в каталозі shared-content, який НЕ призначений для розміщення в каталозі how-to, виконайте наступні дії:

  1. Створіть у папці content_test_bed файл, ім'я якого збігається з іменем вашого нового файлу вмісту, додавши наприкінці «_include».
    • Для style_guide.md слід додати style_guide_include.md.
  2. Використовуючи синтаксис фрагментів, додайте ім’я файлу в filename_include.md. Синтаксис фрагментів для вставлення вмісту — -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).

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