Skip to content

Guide · Agent skill

How to use the Render Markdown to HTML agent skill (render-html)

Updated · written with AI from the project's own documentation and checked against our catalogue data

The render-html skill lets an AI agent convert a Markdown research artifact, such as an ARIS idea report or review summary, into one self-contained HTML page for people to read. It is aimed at researchers using the ARIS workflow and anyone who wants to share a Markdown report as a polished single web page. After this guide you will know what the skill does, how to install it, how to trigger it with plain requests, and what it needs to run.

Render Markdown to HTMLwanshuiyin/Auto-claude-code-research-in-sleep · MIT

Quick start

  1. 1Download the ZIP. Get the render-html skill ZIP from our page.
  2. 2Unzip into a skills folder. Unzip it into ~/.claude/skills/ for personal use or into .claude/skills/ inside a project.
  3. 3Or upload it in the Claude apps. In the Claude apps, go to Settings → Capabilities → Skills and upload the ZIP.
  4. 4Check the requirements. Confirm Python 3 is available and that the ARIS repository layout is present so the helper can be found.
  5. 5Ask for a render in plain language. Say something like "render html" and name the Markdown file, such as idea-stage/IDEA_REPORT.md.
  6. 6Open the result. Open the generated single-file HTML and check the source path and timestamp in the header.

What the render-html skill makes the agent do

Once installed, the agent can take a research artifact written in Markdown and produce one self-contained HTML file with a table of contents, callouts and optional math and code highlighting. The Markdown remains the source of truth. The HTML is a generated reading view that records the source file's hash and timestamp, so you can tell whether it has gone stale.

The skill is built for artifacts that have a real human reader, such as IDEA_REPORT.md, AUTO_REVIEW.md, KILL_ARGUMENT.md, PAPER_PLAN.md and research-wiki summaries.

  • Academic template for idea reports, review rounds and kill arguments
  • Dashboard template for research-wiki cockpit-style views
  • Drift detection: source path, SHA256 and generation time are stored in the page

Install the render-html skill

Download the ZIP for this skill from our page. Then choose one of two routes.

For a personal install, unzip it into ~/.claude/skills/. For a single project, unzip it into the project's .claude/skills/ folder. Alternatively, upload the ZIP in the Claude apps under Settings → Capabilities → Skills.

  • Personal: unzip into ~/.claude/skills/
  • Project only: unzip into .claude/skills/ inside your project
  • Claude apps: Settings → Capabilities → Skills, then upload the ZIP

Trigger the skill with natural requests

You do not need to type a command. The skill is meant to be triggered by plain requests. The source lists these phrases: "渲染 HTML", "出一份 HTML 报告", "render html", "make this readable" and "export to html". You can also simply ask for a polished web-rendered view of a Markdown artifact.

Name the file when you can, so the agent knows which artifact to convert.

  • "Render idea-stage/IDEA_REPORT.md as HTML so I can read it"
  • "Make this readable: review-stage/AUTO_REVIEW.md"
  • "Export to html the research-wiki summary"

Options you can ask for

The skill's argument hint lists the main options. The default template is academic. Ask for the dashboard template for cockpit-style views. You can name an output path, set a title, embed a sidecar state or JSON file, or render without network access.

  • --template academic|dashboard
  • --out <path> to choose the output file
  • --title and --state <state.json> or --json <sidecar.json>
  • --offline to skip loading MathJax and highlight.js
python3 "$RENDER_HTML" idea-stage/IDEA_REPORT.md

What the skill needs and safety notes

The helper is written in Python 3 using only the standard library, so there are no pip installs. It needs the ARIS repository layout so the helper script can be located. By default the page loads MathJax and highlight.js from cdn.jsdelivr.net, which needs internet access; --offline avoids this, with math shown as raw text and no code highlighting.

The skill runs a script locally and uses the network by default. The HTML sanitizer removes script, iframe, form and similar tags, event-handler attributes and unsafe javascript:, vbscript: and data: links. It is a safety net, not a substitute for reviewing untrusted input, so avoid rendering Markdown from unknown sources.

  • Requires Python 3 (standard library only)
  • Optional internet access to cdn.jsdelivr.net unless --offline is used
  • Requires the ARIS repository layout to locate the helper script
  • Runs scripts and uses the network

Tips for good results

Edit the Markdown, then render again. Do not edit the HTML, because it is regenerated from source and manual changes will be lost. Use the academic template for artifacts humans read, and the dashboard template for cockpit views.

Do not use this skill for LaTeX paper output, since the final reader artifact is a PDF. Also avoid it for SKILL.md files and review traces, which are internal.

  • Treat the Markdown as the editable file; regenerate the HTML after changes
  • Check the source path and timestamp in the page header to confirm freshness
  • Use --offline when you have no internet access

What people use it for

  • Turning an IDEA_REPORT.md into a ranked, readable decision page with a table of contents
  • Viewing AUTO_REVIEW.md round-by-round scores in a single shareable web page
  • Reading KILL_ARGUMENT.md attack and defense points as expandable cards with colour callouts
  • Sharing a research-wiki summary as a dashboard-style page
  • Rendering reports offline when internet access is unavailable

Frequently asked questions

How do I install the render-html skill?

Download the ZIP from our page and unzip it into ~/.claude/skills/ for personal use or into a project's .claude/skills/ folder. You can also upload the ZIP in the Claude apps under Settings → Capabilities → Skills.

What does the render-html skill require?

It requires Python 3 using only the standard library, so no pip installs. It also needs the ARIS repository layout so the helper script can be found. Internet access is optional and only needed for MathJax and highlight.js unless you use --offline.

Is render-html free to use?

The source is published under the MIT licence. This page does not state any price, so check the repository for licence terms.

Can I use render-html without internet access?

Yes. Ask for offline rendering, which corresponds to the --offline option. Math then appears as raw text and code blocks are not syntax highlighted, but the page stays readable.

Why does my rendered HTML look out of date?

The HTML is a generated view and embeds the source path, SHA256 and generation timestamp. Compare these with your Markdown file. If they differ, render again from the current source instead of editing the HTML.

Can I edit the HTML directly to change the report?

No. The HTML is regenerated from the Markdown source, so manual edits will be lost. Change the Markdown and render again.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Use render-html if you work with the ARIS workflow or need to share a Markdown research report as a polished single web page, and you are comfortable running a local Python helper. Pick something else if you need LaTeX or PDF output, want to hand-edit HTML, or need to render Markdown from untrusted sources.

Download the skill