Personal project · Web Components + WebAssembly · In development

Readme Studio

A browser-based editor for building GitHub profile READMEs with editable sections, live preview, and standard Markdown export.

My role: Creator · Developer

Live demo GitHub

Explore the sample profile, edit the Markdown, and export a README. No sign-in is needed; drafts stay in your browser. The workspace follows your system's light or dark preference.

The problem

Creating and editing profile READMEs means managing Markdown while checking how GitHub will render it.

The solution

Readme Studio lets users compose profile sections, edit Markdown directly, review a GitHub-style preview, and export an ordinary README.md.

My contributions

Built a browser-based authoring experience from native Custom Elements and shared CSS.
Added local drafts, editable sections, and Markdown import/export while preserving source text.
Added optional WebAssembly acceleration for README Health statistics with a JavaScript fallback.

Engineering decisions

Structured builder fields and free-form Markdown can conflict. Studio preserves source text as users move between the visual builder and editor, while keeping exported README files usable without the app.

Testing

CI runs unit and browser workflow suites across Chromium, Firefox, and WebKit. The project also documents accessibility checks as regression coverage.