Skip to content

docs: note markdown code fences are type-checked #7291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bartlomieju merged 1 commit into from
Sep 17, 2026
+4 −0
Merged

docs: note markdown code fences are type-checked #7291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ Example snippets must be reproducible and use `@std/assert` assertions. Use
`ignore` directive to skip running a snippet, `expect-error` for expected
failures, `no-assert` to exempt a snippet from requiring assertions.

`deno task test` (via `--doc`) also type-checks TypeScript code fences in
markdown files such as README.md; mark snippets that cannot run in CI by tagging
the fence `ts ignore` instead of `ts`.

Module files (`mod.ts`) need a `@module` tag.

## Error Message Style
Expand Down
Loading