Skip to content

rendermd

Jump to bottom
Hyuk edited this page Jun 2, 2026 · 2 revisions

rendermd Wiki

A static web tool that previews LLM-generated markdown in real time and exports it as a PDF.

Live site: https://boostcampwm-snu-2026-1.github.io/rendermd-hyuk/ Repository: https://github.com/boostcampwm-snu-2026-1/rendermd-hyuk

Authoritative docs live in the repo under docs/ so they are versioned with the code. This wiki is the landing page for the Boostcamp submission convention.

Week-by-week deliverables

Week 1 — planning

Week 2 — core implementation

  • Markdown editor (CodeMirror 6) and live preview (react-markdown + remark-gfm + remark-math + rehype-katex + rehype-highlight)
  • Theme system (light / dark / sepia / high-contrast) with FOUC-free hydration via inline init script
  • Draft autosave hook with quota / unavailable / unknown error classification and Retry UI
  • Week 2 Retrospective

Week 3 — polish & deploy

  • GitHub Pages deploy with basePath: '/rendermd-hyuk', OG / Twitter / PWA metadata, static manifest
  • Print stylesheet hardened for real PDF export (table flow, page-break markers, dark-theme edge-to-edge layout, @page margin: 0 with internal padding)
  • Bundle reduced to 109 kB First Load JS via lazy-loaded editor + preview chunks; perf budget enforced in CI
  • Week 3 Retrospective

Post-shipping fixes

  • canonicalizeBlockMath preprocessor — rescues compact $$\begin{aligned}...$$ shapes (a common LLM-output mistake) before remark-math sees them
  • Editor scroll fix — min-height: 0 on grid items and forcing the @uiw/react-codemirror intermediate <div> to fill its parent, so .cm-scroller has bounded clientHeight and trackpad wheel actually scrolls
  • Soft-wrap editor lines (EditorView.lineWrapping) per markdown-editor convention

Multi-agent review pattern

Each PR runs three independent sub-agents (verifier / FE reviewer / UI-UX worker) on the diff or the live site. PDF inspection is part of the verifier's job — Playwright captures PDFs and Claude's Read tool renders PDF pages as images, so the agent actually sees the rendered output rather than guessing from CSS. Pattern is codified in §3 of the workflow doc.

Task management

Contributing / conventions

  • CONTRIBUTING.md
  • Branch strategy: feature/* → dev → main, no direct pushes to main
  • Conventional Commits enforced by Husky + commitlint
  • PR template includes verifier-agent and reviewer-agent reports

Author

최재혁 / jay20012024

Clone this wiki locally