Index of every page on this site: llms.txt
All skills
markdown-viewer avatar

/documd-visuals

@2672b69
by Markdown Viewermarkdown-viewer/skills3.4k stars
192
Run it yourself

Create text-driven visuals in Markdown: charts, diagrams, cards, architecture and page layouts. Charts and analytical views (bar, line, pie, heatmap, correlation, regression); reliability and operations (latency, incident, throughput, cycle time, OKR, standup, on-call); product and finance (funnel, retention, revenue, budget); process and workflow (approval, BPMN); software design and behaviour (class, state machine, sequence, C4); dependencies and impact (dependency graph, ER, causality); system architecture as HTML (layer stack, wings, zones, topology, service catalogue, request paths); infrastructure (cloud, Kubernetes, ETL, network, security, IAM, compliance); governance and people (ArchiMate, org chart, hiring); knowledge and planning (mind map, roadmap, Gantt, migration); documents (comparison, SWOT, memo, policy, catalogue, case study). Use when a document needs a diagram, chart or card. Figures render live. Not for slide decks or math notation. Not recommended: mermaid / canvas / drawio / dot.

Use this Skill: https://skilld.dev/gh/markdown-viewer/skills/documd-visuals

Nothing lands on disk. Nothing to clean up.

Fork this Skill

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

enginesecharts.md

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

echarts

Chart options rendered as static images: report-grade charts and KPI boards. Runtime: echarts 6.1.0 (full package, no echarts-gl). Fence: ```echarts — the block body is a JSON option object, not JavaScript.

Scope

Family Series type
Trends line (stacked areas, step, smooth, bump)
Comparison bar (grouped, stacked, normalized, radial on polar, showBackground tracks)
Part-of-whole pie (donut, rose roseType, nested rings with label.rich)
Correlation scatter · effectScatter
Distribution boxplot · heatmap (+ calendar)
Hierarchy tree · treemap · sunburst
Flow sankey · funnel · chord
Relations graph (force or circular) · lines
Multi-metric radar · parallel · matrix
Time / composition themeRiver · calendar
Status gauge (dial, ring, progress)
Sizing pictorialBar
Financial candlestick

Components: title · legend · grid · xAxis/yAxis · polar/radiusAxis/angleAxis · radar · visualMap · markLine/markArea/markPoint · dataset + encode · graphic · aria · parallel/parallelAxis · calendar · matrix.

Fit

  • Choose ECharts for report-grade charts: one clear reading, explicit axes, styled series, annotations (threshold bands, target lines), KPI dashboards assembled from several charts in one option.
  • Choose ECharts over Vega-Lite when the visual polish and the built-in series library matter more than data transformation. Choose Vega-Lite when the data needs reshaping first.
  • Choose ECharts over the chart-* infographic templates once axes, multi-series data or statistical shapes are involved.

Styling

Colour comes from the chosen theme — pick one in ../styles/palette.md, then copy that theme's one-line "color" ramp (for example ../styles/themes/default.md). Before adding a colour by hand, know how the ramp is distributed:

chart shape what the ramp colours
several series one colour per series, in order
one series with coloured items (pie, sunburst, treemap) one colour per data item, in order
one series, one colour only color[0] — the rest of the ramp is idle

itemStyle.color on a series overrides the top-level color. Never set textStyle / axisLabel.color / backgroundColor, and never hand-write a series colour the ramp already supplies: an unstyled spec falls back to the engine's own accent (#5070dd).

Constraints (verified, not assumed)

  • The option must be pure JSON — no functions. formatter, renderItem (custom series) and every other callback are impossible. Format with template strings instead: "{b}\n{d}%", "-{c}", "gate · 90".
  • ❗ dataset.transform is broken in 6.1.0 (the current release): any sort/filter transform makes setOption throw RangeError: Maximum call stack size exceeded, under both the SVG and canvas renderers. Sort and derive upstream, then hand ordered rows to dataset.source. dataset + encode without transforms works fine.
  • No maps: map/geo need registerMap with map data that the package does not ship → geographic displays are out of scope.
  • No 3D/GL: globe, bar3D, scatter3D, surface, map3D, lines3D, graphGL and friends need echarts-gl, which is not installed.
  • The renderer uses the SVG renderer: canvas-only effects are unavailable (lines.effect trails, heatmap blending). Large datasets (> a few thousand points) are not appropriate.
  • Animation is off by default: layouts that normally settle by simulation (graph force) must specify static geometry (layout: "circular" or explicit x/y).
  • Interactive components are pointless in an export and should be omitted: tooltip · dataZoom · toolbox · brush · axisPointer · timeline · thumbnail.
  • width/height at the top level of the option set the canvas size (defaults 800×450). Do not set backgroundColor — the renderer forces a transparent background.

Anti-patterns

❌ Don't ✅ Do
A callback in formatter Template strings ("{c}%"), per-item label objects, or pre-computed label fields
dataset.transform Sort/filter upstream
Relying on a force layout settling layout: "circular" or explicit coordinates
tooltip / dataZoom for a static figure Drop them; exports cannot show them
A pie with eight slices bar (ranked), treemap, or sunburst
A truncated value axis on a diverging chart Keep zero in the axis range; the sign is the message
Stacking series measured in different units Grouped bars, or two charts
Radial bars for non-cyclic categories The polar system only pays off when the axis wraps (hours, weekdays, sectors)
Filling a wide frame with barMaxWidth unset Set barMaxWidth/barWidth — bars otherwise become slabs

Sources

Source: SKILL.md on GitHub

Skill behaviors

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.

Third-party checks

No alerts16d3 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    This skill provides documentation and examples for creating various visuals in Markdown using engines like ECharts, Vega, PlantUML, and HTML. It recommends using the vendor-owned @markdown-viewer/documd CLI tool for document conversion and verification. The skill itself contains no executable code or malicious patterns.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

Provenance

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

Last checked against GitHub 2 weeks ago.

Activeupdated 3 weeks ago

Capability

Other metadata
compatibility
Figures are text in the Markdown — fenced blocks or bare HTML — and the host viewer renders them live: nothing to pre-render, build or install. Export to html / epub / docx / pdf is optional and needs Node 18+ and Chrome/Chromium, via `npx @markdown-viewer/documd`.

README badge

README badge for markdown-viewer/skills