jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 09:57:42 -05:00
Code Issues Projects Releases Wiki Activity

Include accessibility considerations in code annotation guidelines (#38835)

Browse Source
This commit is contained in:
Ethan Palm
2023-07-10 15:49:26 -07:00
committed by GitHub
parent 2faebee274
commit 7ff2dfc144
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
contributing/code-annotations.md
View File

@@ -8,6 +8,8 @@ For new users, code annotations are a way to go beyond the high level overview o
For more experienced users, code annotations can help them understand a code example and then tailor it to their specific needs. Annotations can explain why code was written a certain way so that the fundamentals are clear.
You can annotate multiple code examples in a single article, but keep in mind that each annotation increases the complexity of an article and adds repetitive navigation tasks for people using screen readers. If you have multiple code examples in an article, consider whether they can be combined into a single example.
## Enabling and adding code annotations
1. Specify the `layout: inline` frontmatter property for the article.