body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; line-height: 1.6; margin: 0; padding: 20px; max-width: 800px; margin: 0 auto; }
h1, h2, h3 { color: #2563EB; }
.section { margin-bottom: 40px; }
.code { background: #f4f4f4; padding: 10px; border-radius: 4px; font-family: monospace; }
.back-link { display: inline-block; margin-bottom: 20px; padding: 10px 20px; background: #2563EB; color: white; text-decoration: none; border-radius: 4px; }
.back-link:hover { background: #1D4ED8; }
← Back to App
ReadabilityReport Documentation
What is ReadabilityReport?
ReadabilityReport is a web application that analyzes text readability using four major formulas: Flesch Reading Ease, Flesch-Kincaid Grade Level, Gunning Fog Index, and SMOG Index. It provides sentence-level highlighting, paragraph breakdowns, and PDF reports to help writers optimize their content.
How to Use
Basic Usage
- Paste your text into the textarea (up to 5,000 characters).
- Click "Analyze Readability".
- View scores, highlights, and suggestions.
- Switch to "By Paragraph" for detailed breakdown.
- Export a PDF report (free tier includes watermark).
File Uploads
Upload .txt, .docx, or .pdf files. The app extracts text and analyzes it automatically.
Understanding the Scores
Flesch Reading Ease
0-100 scale. Higher = easier to read.
- 90-100: Very Easy (5th grade)
- 60-70: Standard (8th-9th grade)
- 0-30: Very Difficult (college graduate)
Grade Level Formulas
Estimated school grade level required to understand the text.
- 0-6: Elementary
- 7-12: Middle/High School
- 13+: College/Professional
Audience Labels
Based on average grade:
- Elementary: Grades 1-6
- Middle School: Grades 7-9
- High School: Grades 10-12
- College: Grades 13-16
- Graduate: 17+
Sentence Highlighting
Text is highlighted based on difficulty:
- Green: Easy sentences
- Yellow: Hard sentences (4+ grade levels above average)
- Red: Very hard sentences (6+ grade levels above average)
Paragraph Breakdown
Each paragraph gets its own analysis:
- Individual grade level
- Status: ✓ Good or ⚠️ Needs work
- Tips for improvement
- Complex words list
- Longest sentence
PDF Export
Generates a multi-page report including:
- Cover page with recommendations
- Paragraph breakdown
- Highlighted text
- Full text
Free tier includes watermark. Pro tier offers clean exports.
Technical Details
Formulas
All formulas are public domain:
Flesch Reading Ease = 206.835 - 1.015 × (words/sentences) - 84.6 × (syllables/words)
Flesch-Kincaid Grade = 0.39 × (words/sentences) + 11.8 × (syllables/words) - 15.59
Gunning Fog = 0.4 × [(words/sentences) + 100 × (complex words/words)]
SMOG = 1.0430 × √(polysyllables × 30/sentences) + 3.1291
Syllable Counting
Uses the syllable npm package. Complex words = 3+ syllables (excluding proper nouns, compounds, suffixes).
Limits
- 5,000 character input limit
- Client-side processing (no data sent to servers)
- PDF export uses jsPDF (lazy-loaded)
Troubleshooting
Common Issues
- Low scores on simple text? Check for multi-syllable words or long sentences.
- Upload not working? Ensure file is .txt, .docx, or .pdf under 5MB.
- PDF export fails? Try a smaller text or check browser console.