Live GitHub-style markdown preview with TOC, search, exports, validation, and README quality checks.
Paste, upload, or drag a README file here. Everything runs locally in your browser.
12npm install
npm run dev| Action | Shortcut |
|---|---|
| Search | Ctrl + F |
| Paste | Ctrl + V |
| Print PDF | Export > PDF |
MIT
Preview, audit, search, and export GitHub-style README Markdown files locally with live Table of Contents, code syntax highlighting, and quality linting.
Pixel-perfect GitHub Flavored Markdown rendering.
Auto-generated table of contents for easy navigation.
0–100 quality score & linting for documentation standards.
All parsing and exports run securely inside your browser.
Use this sample README containing headings, task lists, code fences, and callout alerts to test live rendering, TOC generation, and quality auditing.
# Awesome Project > [!NOTE] > This is a sample README. Paste your markdown to preview, audit, and export. ## Features - [x] Live GFM Preview with TOC - [x] Quality score & lint validation - [ ] Add more documentation sections ## Installation ```bash npm install awesome-project ``` ## License MIT
A fast three-step workflow to preview, audit, and export repository README documentation.
Paste Markdown text into the editor, drag & drop a .md file, or fetch a raw README directly from a GitHub URL.
The engine parses GFM tables, task lists, code blocks, and callout alerts while computing a 0–100 quality audit score.
Use the sticky Table of Contents to navigate headers, search matching keywords, or export to HTML, PDF, or Markdown.
A comprehensive tool for viewing, auditing, navigating, and exporting repository documentation.
Preview GitHub Flavored Markdown typography, tables, and task lists
Jump to any section with an auto-generated Table of Contents
Get 0–100 documentation quality ratings and section completeness checks
Search text across source code and rendered preview simultaneously
Load README Markdown directly from any GitHub raw file link
Download styled HTML docs or print high-quality PDF documentation
Clean up indentation, trailing spaces, and header formatting in one click
Syntax highlight code blocks for 20+ programming languages
Check off roadmap items and task checkboxes `[x]` dynamically
Render `[!NOTE]`, `[!TIP]`, and `[!WARNING]` callout boxes
Copy Markdown source code, individual sections, or code snippets
No data is sent to external servers; 100% local browser execution
Key development and documentation scenarios where the README Viewer adds value.
Audit your `README.md` before releasing open-source packages on GitHub or npm.
Preview Markdown changes in PRs locally with live TOC and line highlights.
Export GitHub README files as styled HTML pages or printable PDFs.
Use the sticky Table of Contents to navigate massive project documentation.
Inspect raw README files directly from GitHub URLs without cloning repos.
Use auto-formatting to clean up headings, list indentation, and spacing.
Everything you need for previewing, auditing, searching, and exporting GitHub Markdown files.
Render Markdown into pixel-perfect GitHub Flavored Markdown (GFM) output with typography, tables, and alerts.
Navigate large README files with a dynamic, sticky Table of Contents that highlights your reading progress.
Get a 0–100 quality score and linting feedback for missing titles, installation guides, licenses, and broken code blocks.
Search and highlight matching text across both the Markdown source editor and rendered preview simultaneously.
Fetch raw README files directly from GitHub or any remote URL with a single click.
Export documentation to Markdown (.md), HTML (.html), PDF (.pdf), or Word (.docx) formats.
Fenced code syntax highlighting for TypeScript, JavaScript, Python, Go, Rust, Java, SQL, Docker, and YAML.
Track completed and open roadmap items with interactive task list checkboxes `[x]` and `[ ]`.
Zero server uploads. Everything parses, audits, and exports locally inside your browser engine.
Trusted by open-source maintainers, frontend engineers, technical writers, and DevOps teams.
Generic text editors show raw Markdown code without live rendering or quality linting. Our README Viewer is tailored specifically for GitHub documentation.
Frequently asked questions about README rendering, TOC generation, quality checks, and exports.
A README Viewer is an interactive online tool that renders raw Markdown files (`README.md`) into formatted, GitHub-style HTML pages complete with syntax highlighting, an automatic Table of Contents (TOC), quality checks, and export options.
Explore more free developer tools to speed up debugging, testing, and development.
