Skip to content
gebrilliantPublic

About

Turn Markdown into beautiful shareable cards (SVG) — zero dependencies, CJK-friendly

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdcard 📸

Turn Markdown into beautiful shareable cards — from your terminal. Zero dependencies.

把 Markdown 一键变成精美的分享卡片(SVG),专为社交媒体、公众号、README 展示设计。零依赖,装完即用。

npx mdcard-cli note.md --theme gradient --footer "@yourname"

✨ Features / 特性

  • 🎨 3 themes: light / dark / gradient
  • 🇨🇳 First-class CJK support — 中文排版不错行、不截断
  • 📦 Zero dependencies — 零依赖,安全、快
  • 🖼️ Markdown subset: headings, bold/italic/inline-code, links, lists, quotes, code blocks
  • 🏷️ Window title bar + footer watermark (your handle)

Install / 安装

npm install -g mdcard-cli
# or run once
npx mdcard-cli README.md -o card.svg --theme dark

Usage / 用法

mdcard <input.md> [-o out.svg] [--theme light|dark|gradient] [--title "..."] [--footer "..."]
Option Description
-o, --output Output SVG path (default: <input>.svg)
-t, --theme light (default), dark, gradient
--title Title in the window bar
--footer Footer text, e.g. your GitHub/Twitter handle

Example input / 输入示例

# Why I built mdcard

Sharing code snippets on social media
shouldn't require a screenshot editor.

- Zero dependencies
- CJK-friendly wrapping
- Beautiful by default

Output / 输出

SVG 无损缩放,可直接贴到公众号、Twitter、小红书;需要 PNG 时用任何 SVG→PNG 工具转换。

Roadmap

  • PNG output (built-in, no native deps)
  • More themes + custom colors
  • GitHub Action: auto-generate README social cards

💖 Support / 支持作者

If mdcard saves you time, consider sponsoring: 如果这个工具对你有用,欢迎赞助支持,也可以在 README 里挂上你的作品:

License

MIT

About

Turn Markdown into beautiful shareable cards (SVG) — zero dependencies, CJK-friendly

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages