CtrlK
BlogDocsLog inGet started
Tessl Logo

pantheon-ai/markdown-authoring

Author high-quality Markdown documentation with deterministic structure, lint compliance, and CI integration. Use when writing README files, creating docs pages, fixing markdownlint failures, defining style rules, or wiring markdown checks into pre-commit and pipelines. Keywords: markdown, markdownlint, readme, docs, headings, lists, code fences, links, images, lint config, ci, documentation style.

95

1.00x
Quality

92%

Does it follow best practices?

Impact

97%

1.00x

Average score across 7 eval scenarios

SecuritybySnyk

Passed

No findings from the security scan

Overview
Quality
Evals
Security
Files

task.mdevals/scenario-2/

Author a README from Scratch

Create a README.md for an open-source CLI tool called snapcheck. The tool:

  • Is written in TypeScript and distributed via npm.
  • Accepts a config file path and a URL, then checks whether a webpage's visual snapshot matches a stored baseline.
  • Has three commands: init, check, and update.
  • Requires Node 18+ and can be installed globally via npm install -g snapcheck.

Produce a README.md for snapcheck that:

  1. Starts with a single H1 title.
  2. Uses the document structure: Overview → Installation → Usage → Commands → Configuration → Contributing.
  3. Never skips a heading level (all sub-sections are H3 under their H2 parent sections).
  4. Shows all shell commands in fenced code blocks tagged with bash.
  5. Shows all config file examples in fenced code blocks tagged with the appropriate language (yaml, json, etc.).
  6. Uses a consistent list marker style throughout.
  7. Includes a table for the Commands section listing each command, its syntax, and a brief description.

Produce a single file README.md with the complete documentation.

SKILL.md

tile.json