Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Latest commit

 

History

History
History
32 lines (19 loc) · 682 Bytes

File metadata and controls

32 lines (19 loc) · 682 Bytes
Copy raw file
Download raw file
Outline
Edit and raw actions

pxt-checkdocs Manual Page

@description Validates documentation

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

pxt checkdocs [--re foo]

Description

This commands scans the documentation and perfoms 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.

See Also

pxt tool

Morty Proxy This is a proxified and sanitized view of the page, visit original site.