<a href="https://microbit-foundation.github.io/makecode-embed/" class="typedoc-ignore">This documentation is best viewed on the documentation site rather than GitHub or NPM package site.</a>
npm install @microbit/makecode-embedThis documentation is best viewed on the documentation site rather than GitHub or NPM package site.
This is a React/JavaScript library for embedding Microsoft MakeCode as an iframe.
It is intended to be used by other Micro:bit Educational Foundation projects
that need to embed MakeCode and, when the API stabilises, to be useful to others
who embed MakeCode.
- StoryBook demo of the components
- React usage documentation
- VanillaJS usage documentation
This software is under the MIT open source license.
We use dependencies via the NPM registry as specified by the package.json file under common Open Source licenses.
The MakeCode/PXT types are derived from the Microsoft MakeCode/PXT repository as of 954d72b3a763608ca6f484807f511591ce48691a under a MIT license.
Full details of each package can be found by running license-checker:
``bash``
$ npx license-checker --direct --summary --production
Omit the flags as desired to obtain more detail.
Trust, partnership, simplicity and passion are our core values we live and
breathe in our daily work life and within our projects. Our open-source
projects are no exception. We have an active community which spans the globe
and we welcome and encourage participation and contributions to our projects
by everyone. We work to foster a positive, open, inclusive and supportive
environment and trust that our community respects the micro:bit code of
conduct. Please see our code of conduct
which outlines our expectations for all those that participate in our
community and details on how to report any concerns and what would happen
should breaches occur.