Adding a new UX tool: a readability report. Here are some of the reasoning behind this:
Guidelines and Their Sources: > Search engine optimization (SEO) experts Brain Dean from Backlinko and Neil Patel advocate using short paragraphs (usually one or two sentences) to optimize for readability and scannability. [Website Design for Scannability – 8 UI Tips and Proven Reading Patterns](https://www.uxpin.com/studio/blog/website-design-for-scannability#h-short-paragraphs-over-blocks-of-text)
> How short is short? Less than 100 words seems to be the conventional wisdom on how long web paragraphs should be. The content will drive how you chunk the information. Cut out what’s unnecessary to getting your point across. Start a new paragraph when you find yourself veering away from the one single point of the paragraph. [Writing for the Web | Helping Readers Skim and Scan](https://www.parentcenterhub.org/web-scanning/)
Various Website Recommendations on Sentence and Paragraph Lengths * **Max sentences / paragraph**: - "maximum 4 sentences (we recommend 1-3)" [The Step-by-Step Guide to Creating Scannable Content](https://www.quicksprout.com/the-step-by-step-guide-to-creating-scannable-content/) - "Write no more than three or four sentences to convey a message in a paragraph" - [A Beginners Guide](https://digitalguider.com/blog/how-scannable-content-rules-the-internet/#5-_Short_Paragraphs) - "The ideal standard is *no more than* 20 words per sentence, *five sentences per paragraph*."[Public Writing: Writing for the Web](https://guides.lib.uw.edu/bothell/publicwriting/writingfortheweb) * **Max words / sentence** - 16 words / sentence - [The Step-by-Step Guide to Creating Scannable Content](https://www.quicksprout.com/the-step-by-step-guide-to-creating-scannable-content/) - "Any sentence longer than sixteen words is generally considered to be too long." - [A Beginners Guide](https://digitalguider.com/blog/how-scannable-content-rules-the-internet/#5-_Short_Paragraphs) - "The ideal standard is *no more than 20 words per sentence*, five sentences per paragraph." [Public Writing: Writing for the Web](https://guides.lib.uw.edu/bothell/publicwriting/writingfortheweb)
> You can improve the scannability of the content in a few simple ways. Write no more than three or four sentences to convey a message in a paragraph. And attempt composing a few paragraphs that include just one sentence. [How Scannable Content Rules the Internet? [A Beginners Guide](https://digitalguider.com/blog/how-scannable-content-rules-the-internet/#5-_Short_Paragraphs)
>
Best Online Info on Making Text Scannable * [Website Design for Scannability – 8 UI Tips and Proven Reading Patterns](https://www.uxpin.com/studio/blog/website-design-for-scannability/) * [Public Writing: Writing for the Web](https://guides.lib.uw.edu/bothell/publicwriting/writingfortheweb) * [This is why and how to improve the readability of your content](https://knowledgeenthusiast.com/2024/10/29/readability-content/) * [Scannability and Readability in Web Writing](https://www.kerryr.net/webwriting/structure_scan-read.htm)
1.0.9
Adding a little cleanup function as I realized a student who added too many blank line returns triggered an AttributeError.
In the previous release, I added an exception handler for the error, but realized that by cleanin up the CSS, I could avoid other similar errors.
1.0.8
improving report for fonts - making more battle-hardened
1.0.6
Fixed the issue with link color contrast results. Background color wasn't being used correctly to determine contrast results.
1.0.4
Fixed an issue with CSS testing and added to the documentation.