How y1jiong/md2img works
Project type and purpose
• md2img is a single-binary Go HTTP service (full-stack in the sense that it provides a REST API and does server-side rendering).
• It exposes three endpoints (/markdown, /html, /url) to convert input into an image (PNG or JPEG).
File structure
• Top-level: main.go, internal/, util/, manifest/, Makefile, go.mod
• internal/cmd: CLI commands (install, version)
• internal/controller: HTTP handlers for each endpoint
• internal/service:
• browser: invokes headless Chrome (via Chrome DevTools protocol) to render HTML and capture screenshots
• manifest/deploy: Dockerfile, configs, scripts for container image and local deployment
README for insights
• Confirms API routes, parameters (width, mobile, html), and that template customization is possible via template.html.
• Focus is on a stateless HTTP service packaged as a Docker image.
Main components
a. External HTTP Client (e.g., curl, another service)
b. API Gateway / HTTP Server (main.go + router)
c. Controller Layer (internal/controller)
• markdown.go
• html.go
• url.go
d. Service Layer (internal/service)
• Browser Service (headless Chrome wrapper)
f. Optional: CLI Commands (internal/cmd/install.go, version.go)
g. Deployment (Docker image, local.conf, Makefile)
Relationships and data flow
1. HTTP Client → (POST) → HTTP Server
2. HTTP Server → Controller → appropriate handler based on path
3. Handler → Service Layer:
• If /markdown: pass raw markdown → Markdown Service → HTML string
• If /html: pass raw HTML → skip markdown conversion
• If /url: pass URL → Browser Service fetches HTML from remote resource
4. HTML string → Browser Service
5. Browser Service uses headless Chrome → renders page → captures screenshot → returns image bytes
6. Controller → writes image bytes in HTTP response
Architectural patterns and design principles
• Layered architecture (Controller → Service → External engine)
• Separation of concerns: parsing & templating vs. rendering/screenshot
• Stateless, request-driven design for high concurrency
• Single deployable unit (monolith) packaged in Docker for ease of distribution
Technologies & frameworks
• Go standard library (net/http)
• Chrome DevTools Protocol (for headless rendering)
• HTML templating (built-in Go templates)
• Docker (for containerization)
• Clear, concise component labels
• Blue for internal Go components
• Green for external/runtime (Chrome)
• Yellow for deployment/config (Docker, Makefile)