diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index fb53fcdbc3c..e1497c04292 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -81,9 +81,9 @@ } }, "customRules": [ - "./markdownlint/TOP001_descriptiveLinkText.js", - "./markdownlint/TOP002_noCodeInHeadings.js", - "./markdownlint/TOP003_defaultSectionContent.js", - "./markdownlint/TOP004_lessonHeadings.js" + "./markdownlint/TOP001_descriptiveLinkText/TOP001_descriptiveLinkText.js", + "./markdownlint/TOP002_noCodeInHeadings/TOP002_noCodeInHeadings.js", + "./markdownlint/TOP003_defaultSectionContent/TOP003_defaultSectionContent.js", + "./markdownlint/TOP004_lessonHeadings/TOP004_lessonHeadings.js" ] } diff --git a/LAYOUT_STYLE_GUIDE.md b/LAYOUT_STYLE_GUIDE.md index 48731991ce9..ae5fd1d0ac7 100644 --- a/LAYOUT_STYLE_GUIDE.md +++ b/LAYOUT_STYLE_GUIDE.md @@ -76,7 +76,7 @@ The following questions are an opportunity to reflect on key topics in this less ### Additional resources -This section contains helpful links to related content. It isn’t required, so consider it supplemental. +This section contains helpful links to related content. It isn't required, so consider it supplemental. - It looks like this lesson doesn't have any additional resources yet. Help us expand this section by contributing to our curriculum. diff --git a/advanced_html_css/accessibility/accessibility_auditing.md b/advanced_html_css/accessibility/accessibility_auditing.md index 4a8a876c83a..9d561ccd8b2 100644 --- a/advanced_html_css/accessibility/accessibility_auditing.md +++ b/advanced_html_css/accessibility/accessibility_auditing.md @@ -2,12 +2,12 @@ Now that you are equipped with the necessary knowledge to make your websites more accessible to many users, the question arises: How can we verify the correct implementation of a11y features? Are there any mistakes to be corrected, or potential improvements to be made? In this lesson, we will answer those questions to help push your a11y skills over the top. -### Learning outcomes +### Lesson overview -By the end of this lesson, you should be able to: +This section contains a general overview of topics that you will learn in this lesson. -* Open the accessibility section within your browser's DevTools. -* Audit a web page with a third-party auditing tool. +- Open the accessibility section within your browser's DevTools. +- Audit a web page with a third-party auditing tool. ### Accessibility DevTools diff --git a/advanced_html_css/accessibility/accessible_colors.md b/advanced_html_css/accessibility/accessible_colors.md index 2990dfd31f1..b355ab0cb7e 100644 --- a/advanced_html_css/accessibility/accessible_colors.md +++ b/advanced_html_css/accessibility/accessible_colors.md @@ -2,12 +2,13 @@ Although adding color to a page can make it more visually appealing, using the wrong color combination or relying solely on color to convey information can end up making things more difficult to perceive and understand for some users. This doesn't mean you have to limit yourself when choosing color schemes for a website, but it does mean you have to take extra care when actually *using* those colors. -### Learning outcomes -By the end of this lesson, you should be able to: +### Lesson overview -* Understand what a contrast ratio is. -* Know how to check contrast ratios. -* Understand why color alone should not be used to convey information. +This section contains a general overview of topics that you will learn in this lesson. + +- Understand what a contrast ratio is. +- Know how to check contrast ratios. +- Understand why color alone should not be used to convey information. ### Color contrast diff --git a/advanced_html_css/accessibility/introduction_to_web_accessibility.md b/advanced_html_css/accessibility/introduction_to_web_accessibility.md index 2106d6fdd44..2b78b1e921c 100644 --- a/advanced_html_css/accessibility/introduction_to_web_accessibility.md +++ b/advanced_html_css/accessibility/introduction_to_web_accessibility.md @@ -4,9 +4,9 @@ At this point in the curriculum you've learned incredibly valuable concepts in w What you may not have too much an understanding of, though, is the topic of accessibility, often referred to as "a11y" (due to there being 11 letters between the first and last letters). Unfortunately, this is a topic that many people either don't know much about, or just don't take into account when developing websites. If you fit into either of those two categories, you may have adopted some habits that aren't exactly a11y friendly. Before we get into how you can break away from such habits and begin implementing a11y friendly concepts, it's important to first understand some basic information about web accessibility. -### Learning outcomes +### Lesson overview -By the end of this lesson, you should be able to: +This section contains a general overview of topics that you will learn in this lesson. - Explain what web accessibility is. diff --git a/advanced_html_css/accessibility/keyboard_navigation.md b/advanced_html_css/accessibility/keyboard_navigation.md index 7bf6a6a2fe0..0d0973ad5ab 100644 --- a/advanced_html_css/accessibility/keyboard_navigation.md +++ b/advanced_html_css/accessibility/keyboard_navigation.md @@ -2,27 +2,29 @@ Some users aren't able to use a mouse to navigate or operate their computer, and by extension the websites they visit. These users may instead rely on using a keyboard or another assistive technology that can simulate keyboard inputs, such as voice recognition software. Other users may even just prefer using a keyboard over a mouse, or may use a mix of both. These users require proper keyboard navigation, something that can easily be overlooked when developing a website. -### Learning outcomes -By the end of this lesson, you should be able to: +### Lesson overview -* Know the two things that interactive elements must have for keyboard users. -* Understand what focus styles are and why you shouldn't completely remove them. -* Understand what the tab order is. -* Know how to properly hide hidden content from assistive technologies. +This section contains a general overview of topics that you will learn in this lesson. + +- Know the two things that interactive elements must have for keyboard users. +- Understand what focus styles are and why you shouldn't completely remove them. +- Understand what the tab order is. +- Know how to properly hide hidden content from assistive technologies. ### Focus Remember our Rock, Paper, Scissors example that *didn't* use semantic HTML from the... well, Semantic HTML lesson? Another issue with using `
` element. Then there are elements that have a semantic meaning *and* are announced with some sort of context to help users perceive or operate them, like a ` ` element. Then there are elements that have a semantic meaning *and* are announced with some sort of context to help users perceive or operate them, like a `` element along with the elements related to it. This will allow a user to more easily navigate and understand the data being presented.
-* When you use an input element, you should always create a relationship between it and a `