-
Notifications
You must be signed in to change notification settings - Fork 144
Tutorial Runner
Barrie Byron edited this page Apr 26, 2023
·
14 revisions
The zkApp Tutorials at zkApp Tutorials use a tutorial runner to verify TypeScript code. See tutorial-runner.ts in GitHub.
Thanks to a community member contribution, the tutorial checker verifies the TypeScript code in code blocks:
- Code fences require
ts
syntax - Code fences require a valid file path to the example
.ts
file - Code snippets must be valid TypeScript code
- Line numbers and command prompts (
$
) are stripped by the copy-to-clipboard action present on the published doc
For example:
To prevent the verification when you want to show generic TypeScript code blocks as examples of using an API, use an ignore flag: