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

microsoft/pxt-gitbook-sample

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pxt-gitbook-sample

View the demo here.

This repo is a documentation website generated with (Gitbook)[https://toolchain.gitbook.com/] that makes use of the (Gitbook PXT Plugin)[https://github.com/microsoft/gitbook-plugin-pxt] to render Microsoft MakeCode blocks from markdown.

How do I get started?

If you're using Gitbook to generate your documentation pages. You can use the Gitbook PXT plugin to add MakeCode blocks into your documentation.

Follow the steps here: https://github.com/microsoft/gitbook-plugin-pxt or copy the book.json from this repo into you Gitbook root folder.

Once Gitbook installs (run gitbook install) the plugin, you're good to go.

You can configure the MakeCode base url (the target you're using) in the book.json's pluginConfig section.

{
    "plugins": [
        "pxt"
    ],
    "pluginsConfig": {
        "pxt": {
            "baseUrl": "makecode.microbit.org"
        }
    }
}

License

MIT

About

Sample Gitbook book that uses the PXT plugin to render Microsoft MakeCode blocks

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published