Sign upLogin

GSA/christopher

View on GitHub
Star
_guides/web_design_standards.md

Summary

Maintainability
Test Coverage

Trailing punctuation in header
Open

### What are the Web Design Standards?
Severity: Info
Found in _guides/web_design_standards.md by markdownlint

MD026 - Trailing punctuation in header

Tags: headers

Aliases: no-trailing-punctuation

Parameters: punctuation (string; default ".,;:!?")

This rule is triggered on any header that has a punctuation character as the last character in the line:

# This is a header.

To fix this, remove any trailing punctuation:

# This is a header

Note: The punctuation parameter can be used to specify what characters class as punctuation at the end of the header. For example, you can set it to '.,;:!' to allow headers with question marks in them, such as might be used in an FAQ.

Line length
Open

The [Web Design Standards](https://standards.usa.gov/) is a library of design guidelines and code to help government developers and designers quickly create trustworthy, accessible, and consistent digital government services.
Severity: Info
Found in _guides/web_design_standards.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Line length
Open

The Standards allow designers and developers to have a leg-up in updating existing services, or quickly create new websites, to have a modern, consistent feel. They are open source, free to use, and comply with Section 508 and OMB guidance. Currently they are being used on **100 government sites** that collectively **reach more than 26 million users a month**!
Severity: Info
Found in _guides/web_design_standards.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Line length
Open

Our team is also available to work closely with you to develop custom features or train teams on implementing the Standards. If you'd like to talk to the team or explore a partnership, please contact us at [uswebdesignstandards@gsa.gov](mailto:uswebdesignstandards@gsa.gov). If you've got more general questions, you can join us in our new [public Slack channel](https://chat.18f.gov/) or if you have feature requests or find a bug, [please file an issue in our Github tracker](https://github.com/18F/web-design-standards/issues). This project is maintained by [18F](https://18f.gsa.gov/), an office within GSA.
Severity: Info
Found in _guides/web_design_standards.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

First header should be a top level header
Open

### What are the Web Design Standards?
Severity: Info
Found in _guides/web_design_standards.md by markdownlint

MD002 - First header should be a top level header

Tags: headers

Aliases: first-header-h1

Parameters: level (number; default 1)

This rule is triggered when the first header in the document isn't a h1 header:

## This isn't a H1 header

### Another header

The first header in the document should be a h1 header:

# Start with a H1 header

## Then use a H2 for subsections

Line length
Open

Right now, when the American people go online to access government services, they're often met with confusing navigation systems, a cacophony of visual brands and inconsistent interaction patterns. Dedicated federal employees are striving to build helpful digital tools, but our work happens in silos, under unique brands and programs. As a result, we spend a lot of time "reinventing the wheel" - recreating common patterns such as buttons, forms, and search bars - over and over again. At the end of the day, we're creating poor user experiences, and wasting American taxpayer dollars in solving the same problems again and again. So we asked ourselves: **Could we create a shared set of tools to provide consistent, beautiful, and easy-to-use government websites?** Thus the Standards was born.
Severity: Info
Found in _guides/web_design_standards.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Line length
Open

The Standards offer code and guidelines for forms, typography, buttons, alerts and more. The latest release, 1.0, is the culmination of more than a year and a half of design and development through more than 20 versions. And there are more than 3,400 folks, inside and outside government, [following the project on GitHub and contributing back to the code](https://github.com/18F/web-design-standards).
Severity: Info
Found in _guides/web_design_standards.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Line length
Open

[We're looking to expand](https://18f.gsa.gov/2016/12/22/charting-the-future-of-the-draft-us-web-design-standards/) with more mobile performance-optimized components and continued user research to guide our future product decisions. We’re also looking at building more advanced components like mapping and data visualizations.
Severity: Info
Found in _guides/web_design_standards.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

There are no issues that match your filters.

Category
Status