Skip to content

README_EN.md

Latest commit

 

History

History
85 lines (55 loc) · 3.94 KB

README_EN.md

File metadata and controls

85 lines (55 loc) · 3.94 KB
Raw

sd-mind-map: A Codex skill for Chinese article summaries and Mermaid mind maps

简体中文 · English

Validate License: MIT Release

sd-mind-map turns Chinese articles, web copy, short-video scripts, and meeting transcripts into purpose-driven Mermaid mind maps, flowcharts, argument maps, and downloadable dark PNGs.

It does more than shorten text. The skill first asks how the reader plans to use the map, then preserves the relationships, evidence, limits, and source distinctions that matter for that goal.

sd-mind-map converts source material into Mermaid and PNG output

What it delivers

  • Reading modes for quick understanding, study, presentation, execution, and credibility review.
  • Transcript cleanup without silently changing the original meaning.
  • Clear separation between substantive content and promotional packaging.
  • Labels for author claims, evidence, analysis, inference, and limitations.
  • Automatic format selection between Mermaid mindmap, flowchart, argument map, and Markdown tree.
  • Three synchronized Mermaid views: rendered diagram, visible source code, and a dark PNG exported by the bundled local renderer.
  • Optional XMind-friendly Markdown, Markmap, OPML, and Excalidraw structures.

Real examples

Example Reading goal Source Mermaid PNG
How to make a clear short video Execution 90-second script .mmd Image
Can GitHub homepage optimization guarantee more traffic? Credibility review Source note .mmd Image

Browse all examples

Install

  1. Open the latest release.
  2. Download sd-mind-map-v1.3.0.zip.
  3. Extract the sd-mind-map folder into your Codex skills directory.

Windows:

C:\Users\<your-user-name>\.codex\skills\sd-mind-map

macOS / Linux:

~/.codex/skills/sd-mind-map

Try it in 30 seconds

After installation, invoke the skill in Codex and provide a reading goal plus source content:

$sd-mind-map

Goal: 4 — turn this into an actionable workflow.
Chinese content: 写短视频前，先确定观众看完只改变哪一个判断或动作。再保留理解这个结论必须出现的解释、例子和下一步。

If you omit the goal, the skill shows a plain-language menu before generating anything.

Local Mermaid preview and PNG export

The repository includes an offline previewer at:

skill/sd-mind-map/assets/mermaid-preview-lite/index.html

Open it in a browser to paste Mermaid source, zoom, pan, and export. Automatic PNG rendering uses the same logic with a dark background, 2× scale, 32px safe padding, and an 8192px maximum-edge guard.

Automatic export requires Node.js 18+, Chrome or Edge, and Playwright. Codex Desktop normally provides the required runtime.

Limits

  • The skill can only summarize content it can actually access; partial sources are labeled as partial.
  • PNG is a reading artifact, not an editable format. Use the synchronized .mmd file for editing.
  • Very large diagrams may be scaled down to stay within browser canvas limits.

License

Released under the MIT License. Mermaid assets keep their original license; see THIRD_PARTY_NOTICES.md.