Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lint Markdown guide #443

Merged
merged 4 commits into from
Jan 31, 2024
Merged

Conversation

jdbaldry
Copy link
Member

This also removes the guidance to avoid "single-child headings" because I can't find any justification for it online.

Closes #196

Copy link
Contributor

github-actions bot commented Jan 31, 2024

Overall readability score: 60.61 (🔴 -0.03)

File Readability
index.md 66.72 (🔴 -1.46)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
index.md 66.72 50.94 7.76 10.8 12.34 6.84
  🔴 -1.46 🔴 -0.91 🔴 -0.21 🔴 -0.3 🔴 -0.41 🟢 +0.02

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.61 47.42 9.53 11.68 12.15 7.3
  🔴 -0.03 🔴 -0.02 🟢 +0 🔴 -0.01 🔴 -0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@jdbaldry jdbaldry changed the title Addn exception for parentheticals of single backtick quoted characters Lint Markdown guide Jan 31, 2024
Copy link
Collaborator

@chri2547 chri2547 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you for the contribution!

@jdbaldry jdbaldry merged commit fda2925 into main Jan 31, 2024
6 checks passed
@jdbaldry jdbaldry deleted the jdb/2024-01-tip-for-single-child-headings branch January 31, 2024 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Add at least one tip about what to do instead of using single-child headings
3 participants