Writing Docs

MakeCode provides an integrated solution to build documentation.

  • MakeCode flavored markdown the documentation is stored as markdown pages with some additional macros to help with widget formatting.
  • sustainable all block images are rendered on the fly to avoid having to maintain hundreds of screenshots…
  • localizable the documentation is synchronized with Crowdin and localize on the fly by the PXT backend
  • reusable documentation pages can be shared and specialized between targets. It allows to provide a core documentation for the language while specializing the examples.
  • integrated step by step tutorials or sidebar hosted docs allow to surface information within the editor without having to switch to a different browser tab

This page was written using this documentation system, check it out at https://github.com/microsoft/pxt/blob/master/docs/writing-docs.md.