Index of every page on this site: llms.txt
All skills
onmax avatar

/visual-explanation

@aecfada
by Maxonmax/comark-ui43 stars
3
Run it yourself

Explains how something works with the smallest visual that answers the question, such as a sequence diagram, a call tree, a file tree, or a marked-up screenshot, placed beside the sentence it supports. Use when someone asks to be shown how a system, a flow, or a change works, or when the answer would otherwise take paragraphs of prose.

Use this Skill: https://skilld.dev/gh/onmax/comark-ui/visual-explanation

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencesblocks.md

≈602 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Blocks for a visual explanation

These blocks come with comark-ui. The comark-ui skill (vp dlx skills add onmax/comark-ui) documents every block in full.

Diagrams: a mermaid fence

```mermaid
sequenceDiagram
  participant Browser
  participant Worker
  participant Assets
  Browser->>Worker: GET /zoom/
  Worker->>Assets: zoom/index.html
  Assets-->>Browser: prerendered page
```

comark-ui draws Mermaid as SVG while parsing, so the page needs no script to show it. Use flowchart LR for a pipeline, sequenceDiagram for messages between parts, and stateDiagram-v2 for states. Write labels as the code names them. For a diagram in another language, d2, dot, plantuml, dbml, goat, and svgbob fences draw through comark-diagrams.

A call tree: a text fence

```text
renderPage
  parseMarkdown
    plugins' post
  renderHtmlFromDocument
    components
```

Indent by call depth, two spaces a level. Name functions as the code does.

Files: ::file-tree

::file-tree
```
docs/
  build.ts  # renders every page
  ~ style.css
  + pages/
    + skills/
...
```
::

Two spaces nest an entry, a trailing / makes a folder, +, -, and ~ mark added, removed, and changed, and # starts a note. ... stands for entries left out. Write the tree in a fence; a Markdown list renders names like __init__.py as bold.

Line notes: // <1> and a list

```ts
const document = await parseMarkdown(source, { plugins }); // <1>
const html = await renderHtmlFromDocument(document, { components }); // <2>
```

1. Every plugin runs here.
2. Components only draw.

A numbered list right after the fence becomes the notes. The marker goes in a line-end comment in the block's language, such as # <1> in Python.

On screen: ::screenshot

::screenshot{src="https://example.com/settings.png" alt="Settings page with the Save button" viewport="1280x800"}
:::annotation{x=71.2 y=84.1 w=12.4 h=6.3}
**Save** writes all three tabs at once.
:::
::

Measure x y w h from the page as percentages of the image. The before-after-evidence skill explains how.

Numbers: ::chart

::chart{type="bar" title="Build time, seconds"}
| Step | Before | After |
| --- | --: | --: |
| Parse | 4.1 | 1.2 |
| Render | 2.3 | 2.2 |
::

The chart draws from the table, so the numbers in your text and the chart can't disagree.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts20d3 checks · Risk SAFE
  • Gen Agent Trust Hub20d

    The skill provides a set of instructions for generating visual explanations, such as diagrams and file trees, from source code and system data. It includes recommended commands for linting the output using the author's specific tooling. No security threats or malicious behaviors were detected.

  • Socket20d

    No alerts

  • Snyk20d

    Risk: LOW · No issues

Signed by skilld at aecfada. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 3 weeks ago

README badge

README badge for onmax/comark-ui/visual-explanation