Skip to content

Commit 7ab3261

Browse files
update docs with new copy and new scale
1 parent 4b6e983 commit 7ab3261

File tree

3 files changed

+28
-27
lines changed

3 files changed

+28
-27
lines changed

modules/primer-marketing-support/README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,30 @@ The source files included are written in [Sass][sass] (`scss`) You can simply po
2727

2828
You can also import specific portions of the module by importing those partials from the `/lib/` folder. _Make sure you import any requirements along with the modules._
2929

30+
<!-- %docs
31+
title:
32+
status:
33+
-->
34+
3035
## Documentation
3136

3237
### Extended spacing scale
33-
This module includes extra variables that extend the Primer spacing scale for marketing site needs.
34-
Starting from where the `primer-core` spacing scale ends, we are stepping up by 16px increments...
38+
This module extends the `primer-core` spacing scale for marketing site needs. These are useful for achieving bigger vertical spacing between sections on marketing sites.
39+
40+
Starting where the `primer-core` spacing scale ends at spacer 6, the marketing scale first steps up with `8px` for spacer 7 then steps in increments of `16px` from spacer 8 up to 12.
3541

3642
| Scale | Value |
3743
|-------|-------|
38-
| 7 | 56 |
39-
| 8 | 72 |
40-
| 9 | 88 |
41-
| 10 | 104 |
42-
| 11 | 120 |
44+
| 7 | 48 |
45+
| 8 | 64 |
46+
| 9 | 80 |
47+
| 10 | 96 |
48+
| 11 | 112 |
49+
| 12 | 128 |
4350

44-
This is useful for when we want to achieve bigger vertical spacing between sections on marketing sites.
51+
See [primer-marketing-utilities](../primer-marketing-utilities) for related spacing utilities.
4552

46-
See [primer-marketing-utilities](https://github.com/primer/primer-css/tree/master/modules/primer-marketing-utilities) for related spacing utilities.
53+
<!-- %enddocs -->
4754

4855
## License
4956

modules/primer-marketing-utilities/docs/margin.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
---
2-
title: Margin
2+
title: Marketing Margin
33
status: New release
44
status_issue: https://github.com/github/design-systems/issues/378
55
---
66

7-
Margin spacing utilities can be applied to elements to achieve bigger y-directional spaces beyond the `primer-core` spacing scale.
8-
See [primer-marketing-support](https://github.com/primer/primer-css/tree/master/modules/primer-marketing-support) for the extended marketing spacing scale.
7+
Marketing margin utilities extend [core margin utilities](../../primer-marketing-support/docs/spacing) across the y-axis only. The [marketing scale](../../primer-marketing-support) starts from spacer 7 up to 12, and steps first by `8px` for spacer 7 and continues in increments of `16px` for spacer 8 to 12.
98

10-
## Y-Directional margin spacing
9+
## Y-axis margin utilities
1110

12-
Use y-directional utilities to apply margin to the top, bottom or Y axis of an element. Directional utilities can change or override default margins, and can be used with a spacing scale of 7-11.
13-
14-
Note: The marketing spacing scale extends the core 0-6 scale. See [primer-marketing-support](https://github.com/primer/primer-css/tree/master/modules/primer-marketing-support) for the extended marketing spacing scale.
11+
Use marketing margin utilities to apply margin to top, bottom, or both y-axis of an element. These utilities can change or override default margins, and can be used with a spacing scale of 7-12.
1512

1613
```html
1714
<div class="margin-orange d-inline-block">
@@ -25,9 +22,9 @@ Note: The marketing spacing scale extends the core 0-6 scale. See [primer-market
2522
</div>
2623
```
2724

28-
## Responsive y-directional margins
25+
## Responsive y-axis margin utilities
2926

30-
All y-directional margin utilities can be adjusted per [breakpoint](/styleguide/css/modules/grid#breakpoints) using the following formula: `m[y-direction]-[breakpoint]-[spacer]`. Each responsive style is applied to the specified breakpoint and up.
27+
All marketing margin utilities can be adjusted per [breakpoint](/styleguide/css/modules/grid#breakpoints) using the following formula: `m[y-direction]-[breakpoint]-[spacer]`. Each responsive style is applied to the specified breakpoint and up.
3128

3229
```html
3330
<div class="d-inline-block margin-orange">

modules/primer-marketing-utilities/docs/padding.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
---
2-
title: Padding
2+
title: Marketing Padding
33
status: New release
44
status_issue: https://github.com/github/design-systems/issues/378
55
---
66

7-
Padding spacing utilities can be applied to elements to achieve bigger y-directional spaces beyond the `primer-core` spacing scale.
8-
See [primer-marketing-support](https://github.com/primer/primer-css/tree/master/modules/primer-marketing-support) for the extended marketing spacing scale.
7+
Marketing padding utilities extend [core margin utilities](../../primer-marketing-support/docs/spacing) across the y-axis only. The [marketing scale](../../primer-marketing-support) starts from spacer 7 up to 12, and steps first by `8px` for spacer 7 and continues in increments of `16px` for spacer 8 to 12.
98

10-
## Y-Directional padding spacing
9+
## Y-axis padding utilities
1110

12-
Use y-directional utilities to apply padding to the top, bottom or Y axis of an element. Directional utilities can change or override default padding, and can be used with a spacing scale of 7-11.
13-
14-
Note: The marketing spacing scale extends the core 0-6 scale. See [primer-marketing-support](https://github.com/primer/primer-css/tree/master/modules/primer-marketing-support) for the extended marketing spacing scale.
11+
Use marketing padding utilities to apply padding to top, bottom, or both y-axis of an element. These utilities can change or override default padding, and can be used with a spacing scale of 7-12.
1512

1613
```html
1714
<div class="margin-orange d-inline-block">
@@ -25,9 +22,9 @@ Note: The marketing spacing scale extends the core 0-6 scale. See [primer-market
2522
</div>
2623
```
2724

28-
## Responsive y-directional padding
25+
## Responsive y-axis padding utilities
2926

30-
All y-directional padding utilities can be adjusted per [breakpoint](/styleguide/css/modules/grid#breakpoints) using the following formula: `p[y-direction]-[breakpoint]-[spacer]`. Each responsive style is applied to the specified breakpoint and up.
27+
All marketing padding utilities can be adjusted per [breakpoint](/styleguide/css/modules/grid#breakpoints) using the following formula: `p[y-direction]-[breakpoint]-[spacer]`. Each responsive style is applied to the specified breakpoint and up.
3128

3229
```html
3330
<div class="d-inline-block margin-orange">

0 commit comments

Comments
 (0)