What is readmd?

ReadMD is a browser-based Markdown viewer built for reading documentation and technical files with privacy as its core principle. Markdown is a lightweight formatting language used for README files, documentation, and notes, and ReadMD renders those files into clean, readable pages entirely within your browser, nothing is uploaded to a server, stored in a database, or tracked. Beyond basic rendering, it supports several formats that plain Markdown viewers often miss. Mermaid.js diagrams, including flowcharts, sequence diagrams, and Gantt charts, render directly in the page. KaTeX handles LaTeX mathematical notation for scientific documents. It also follows GitHub Flavored Markdown, the variant used in GitHub READMEs and issues. For navigation and reading comfort, it includes a command palette (opened with Ctrl+K) for quick access to controls, an automatically generated table of contents that links to sections in the document, and in-document full-text search. Visual settings like light and dark themes, font size, line height, and content width are all adjustable, and a reading progress indicator shows how far through the document you are. The project is written in TypeScript and uses Vite as its build tool, with Mermaid.js, KaTeX, and Markdown-it as rendering libraries. The styling uses vanilla CSS and HTML5 with no additional UI framework. It is designed to be deployed on Cloudflare Pages, and a live demo is available. It is released under the MIT license.