Skip to content

Blockquotes lack styling, existing blockquote usage is incorrect #1468

Open
@hergaiety

Description

@hergaiety

Problem Summary

  1. Blockquotes are unstyled in the guide
  2. Many guides currently utilize blockquotes in a semantically incorrect way

Example screenshot where the second paragraph is a blockquote:

Screen Shot 2020-07-01 at 10 20 45 AM

As seen in the Testing Components guide

Details

In markdown the > indicates a blockquote html element.

> Hello, I am a blockquote!
> <cite>Gaiety</cite>

The HTML <blockquote> Element (or HTML Block Quotation Element) indicates that the enclosed text is an extended quotation... a text representation of the source can be given using the <cite> element.
MDN web docs

Therefore, we can conclude that we should be using > in guides specifically when a quote is being used along with a reference to the source. Any place that uses > that isn't a quote is incorrect and should be changed.

Proposed Solution

1. Styling the Blockquote

We decide on a blockquote styling. Here's my proposed styling that uses colors and styles pulled from other elements within the guides:

.chapter blockquote {
  font-family: serif;
  font-size: 85%;
  color: #4d4d4d;
  padding: 0.5em 0.75em;
  border: 1px solid #F8E7CF;
  border-radius: 2px;
}
.chapter blockquote :first-child {
  margin-top: 0;
}
.chapter blockquote :last-child {
  margin-bottom: 0;
}

Preview:

Screen Shot 2020-07-01 at 12 08 18 PM

As pulled from #1467

2. Changing existing blockquote instances

We go through existing guides (perhaps just in guides/release, although it'll be up to the learning team how far back we go) to address each instance of a blockquote to remove them, leave them, or change them to something else in markdown.

git grep -n "^> "

@ijlee2

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions