GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

No menu could be recovered. Follow the blue links in the page.

This view

  • Original page
  • New address

GeezerVison is showing makecode.com — pxt-checkdocs Manual Page

Skip to main content
About MakeCode Blog Online Learning Contact Us Tools
Technical Docs
JS Editor Features Programming Language Async Functions Partial Flashing Source Embedding Updating Blockly Version Accessibility Profiling Debugging Hardware
Creating Targets
pxtarget.json Defining Blocks Auto-generation of .d.ts Static File Drops Simulator Theming Editor Embedding resources
Creating Extensions
Getting started pxt.json Extension versioning Extension localization Extension approval Editor extensions GitHub Extension Authoring
Writing Docs
Macros Anchors Tutorials User Tutorials Skillmaps Routing Licensing Testing
Translations
Translation languages Localization files Parts to translate Translating markdown Translator roles In context translation
Blocks Embedding
Command Line Interface
install build bump deploy console gdb staticpkg update pyconv hidserial hiddmesg login
Labs UF2 File Format Accessibility Telemetry

pxt-checkdocs Manual Page

Validates the documentation looking for broken links or broken code snippets.

pxt checkdocs [--re foo]

Description

This commands scans the documentation and performs various validation steps:

  • checking for broken links,
  • compiling and decompiling code samples
  • ...

This command is also automatically run from a cloud build and will fail the build if any issue arises.

Flags

re path (optional)

Regex filter to select files to be scanned for snippets

Other

  • Add a .ignorelargefiles file in a folder to disable large file checks under this folder.
  • Add a .checkdocs-ignore file in a folder to disable snippet / link checks under this folder.

See Also

pxt tool

Edit this page on GitHub
Edit template of this page on GitHub

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.