Giter VIP home page Giter VIP logo

pxt-mkdocs-sample's Introduction

pxt-mkdocs-sample

View the demo here.

This repo is a documentation website generated with mkdocs.org using Microsoft MakeCode for rendering the blocks code.

How to use this repo?

The three main configuration points for add Microsoft MakeCode blocks rendering into your mkdocs project are:

  • mkdocs.yml configuration
  • add embed.js to your docs folder
  • configure embed.js with the makecode website URL you want to use. eg: makecode.microbit.org

mkdocs.yml configuration

Open your mkdocs.yml and add the following configuration lines:

libs: jquery
extra_javascript: [embed.js]

add embed.js

Copy the embed.js file from this repo and insert it into your /docs folder

configure embed.js

Open embed.js in a text editor and make sure you have the correct configuration for the MakeCode website you want to use. For example, if you are writing blocks for the micro:bit. In the top of the file, edit makecodeUrl and change it to "makecode.microbit.org". For Adafruit, use "makecode.adafruit.com" instead.

License

MIT

pxt-mkdocs-sample's People

Contributors

microsoftopensource avatar msftgits avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.