Skip to content

improve typography and color docs #214

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 22, 2019
Merged

improve typography and color docs #214

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f456805
improve typography and color docs
ghislaineguerin Sep 12, 2019
6433025
fix spelling
ghislaineguerin Sep 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions addon/styles/global.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@
--color-danger: #FFD8E1;
--color-warning: #FCFFC9;
--color-info: #E3EEFC;

--text-preset-1: 1.5rem;
--text-preset-2: 2.5rem;
--text-preset-3: 4rem;
--text-preset-4: 6rem;
--text-preset-5: 8rem;
--text-preset-2: 2.25rem;
--text-preset-3: 3.375rem;
--text-preset-4: 5.063rem;
--text-preset-5: 7.594rem;

--font-weight-1: 300;
--font-weight-2: 400;
--font-weight-3: 600;
Expand Down
8 changes: 8 additions & 0 deletions addon/styles/typography.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@
font-size: var(--text-preset-5);
}

h1, h2, h3 {
margin-bottom: var(--spacing-1);
}

p {
margin-bottom: var(--spacing-2);
}

.light {
font-weight: var(--font-weight-1);
}
Expand Down
7 changes: 4 additions & 3 deletions docs/concepts/colours.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Colours

### Here we talk about the color scheme
### Usage
#### Legibility
Website elements like text and icons should meet accesibility standards when used against coloured backgrounds. The following swatches contain a sample of each of the primary palette colours, along with recommendations for its usage and the acceptable contrast guidelines when coupled with text.
Copy link
Member

@MelSumner MelSumner Sep 12, 2019

Choose a reason for hiding this comment

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

Please correct spelling for American English (all of the Ember documentation follows this pattern)



## Primary Colours
The primary palette is applied across every page of the website and contains the brand, accent and neutral colours. The purpose of the primary palette is to keep uniformity across all pages while encouraging accessibility best practices.

The following swatches contain a sample of each of the primary palette colours, along with recommendations for its usage and the acceptable contrast guidelines when coupled with text.

<div class="layout-grid">
<ColorPallet class="col-2-large" @color="#1A1A1A" @name="Dark Gray" @variable="--color-dark" @class-name="bg-dark" />

Expand Down
9 changes: 8 additions & 1 deletion docs/concepts/typeography.md → docs/concepts/typography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Typography

## Sizes
### Usage
#### Legibility
Text legibility is primarily affected by color. All text on the website should comply with the Web Content Accessibility Guidelines (WCAG 2.0) Level AA requirements.


Please refer to the <a href="colours">Colours</a> section for more information on colour contrast and accessibility.
Copy link
Member

@MelSumner MelSumner Sep 12, 2019

Choose a reason for hiding this comment

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

Maybe a find and replace for colour -> color.


### Sizes

Use `.xsmall` for small headings or notice paragraphs.

Expand Down