Перейти к содержанию

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

Этот раздел включен для проверки общего контента, предоставленного из этого репозитория для использования в остальной части документации 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).

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