Skip to content
This repository has been archived by the owner on Jan 29, 2021. It is now read-only.

microsoft/pxt-mkdocs-sample

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

MkDocs documentation sample project that renders Microsoft MakeCode blocks

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published