Структура репозитория блочных образцов

Репозиторий блочных образцов содержит несколько различных категорий проектов. Цель этой страницы – помочь вам понять, где находятся различные категории и что может содержать каждый проект в категории.

Кодлабы

Codelabs — это интерактивные руководства, написанные с использованием синтаксиса уценки и опубликованные на сайтеblocklycodelabs.dev . В Codelabs используется сочетание естественного языка, примеров кода и снимков экрана, чтобы сделать обучение более интересным. Целевой пользователь следует и запускает код по мере его чтения.

Снимок экрана кодовой лаборатории пользовательских средств визуализации

В каталоге codelabs есть шаблон и одна папка для каждой codelab. Каждая папка Codelab содержит файл уценки и все ресурсы (PNG, GIF и т. д.) для Codelab.

Примеры

Примеры представляют собой автономные примеры проектов, демонстрирующие методы включения и расширения библиотеки Blockly. Обычно они состоят из демонстрационной веб-страницы и вспомогательного кода. В то время как Codelabs шаг за шагом поможет вам создать что-то, примеры покажут вам готовый продукт и позволят вам исследовать его в удобном для вас темпе.

Скриншот примера блочной реакции

Код примера должен быть очень хорошо прокомментирован, чтобы его было легко копировать. Целевой пользователь может читать код, запускать его локально или копировать фрагменты кода.

В каталоге примеров имеется по одной папке на каждый пример. Каждый пример может быть запущен с помощью npm install && npm run start и имеет файл README.md с дополнительным контекстом или инструкциями.

Плагины

Плагины — это автономные фрагменты кода, которые добавляют функциональности Blockly. Плагины могут добавлять поля, определять темы, создавать средства визуализации и многое другое. Целевой пользователь — разработчик, который находит и использует плагин через npm. Плагины, определенные в этом репозитории, являются сторонними плагинами, а это означает, что они поддерживаются командой Blockly.

Скриншот

В каталоге плагинов есть одна папка для каждого плагина. У каждого плагина есть каталог src , где содержится код, и test каталог, где находится демонстрационная страница. Они также содержат файл README.md , который предоставляет разработчикам информацию о том, что делает плагин и как его использовать.

Страницы Гитхаба

У Blockly-samples есть веб-страница , на которой многие плагины и демоверсии доступны в игровой среде. Эта страница размещена на страницах GitHub, а код этого сайта находится в каталоге блочных образцов gh-pages . В этом каталоге находятся шаблоны страниц сайта. Фактический контент сайта генерируется на основе этих шаблонов и метаданных каждого размещенного плагина или примера.