report-in-markdown

Validate Markdown reports for KaTeX math, citations, tables, and metadata.

8|2|Updated Apr 9, 2026
One-click install
npx skills add https://github.com/FuZhiyu/superRA --skill report-in-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: report-in-markdown
Source: https://github.com/FuZhiyu/superRA/tree/main/skills/report-in-markdown
Command: npx skills add https://github.com/FuZhiyu/superRA --skill report-in-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pytest, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill prevents Markdown rendering errors and inconsistent reporting practices when creating task files, status updates, and standalone research reports.

Core Features & Use Cases

  • Source File References: Links source files with relative Markdown paths and line anchors for traceable citations.
  • Math and Table Formatting: Applies KaTeX-compatible math syntax, display-math spacing rules, consistent tables, and guidance for large outputs.
  • Rich Content and Reports: Handles figures, raw HTML layouts, report metadata, filenames, attachments, and reproducible output paths.
  • Validation: Uses a diagnostic checker to detect broken display math, undefined KaTeX operators, and inline math spans split across lines.

Quick Start

Use the report-in-markdown skill to revise the provided research report so its citations, equations, tables, figures, and metadata follow the Markdown style guide.

Frequently Asked Questions about report-in-markdown

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix KaTeX rendering errors in Markdown research reports?

Markdown rendering errors in research reports are fixed by validating KaTeX syntax, enforcing display-math spacing rules, and preventing inline math spans from splitting across lines. A diagnostic checker detects broken display math and undefined operators before publication.

How do I add source citations with line anchors in Markdown documents?

Source citations in Markdown documents are added by linking source files with relative paths and line anchors. This creates traceable references that connect report content directly to specific lines in the original source files.

Does Markdown validation work with pytest for checking tables and figures?

Markdown validation requires pytest as a dependency to run diagnostic checks on tables, figures, and mathematics. The validation process detects broken display math, undefined KaTeX operators, and improperly formatted report metadata.

What's the best way to format large table outputs in Markdown reports?

Large table outputs in Markdown reports are formatted using consistent table conventions alongside guidance for managing extensive data displays. The approach ensures tables remain readable and render correctly across different Markdown viewers.

Why does inline math break across lines when rendering Markdown with KaTeX?

Inline math breaks across lines when KaTeX syntax is split or improperly spaced within the Markdown text. A diagnostic checker identifies these split inline math spans and validates display-math spacing to prevent rendering failures.

Can I include report frontmatter and figure attachments in Markdown research documents?

Report frontmatter and figure attachments are fully supported in Markdown research documents. The skill handles metadata, filenames, attachments, and reproducible output paths to create publication-ready reports with traceable source links.