Skip to content
This repository was archived by the owner on Oct 1, 2024. It is now read-only.

Commit 12a9a65

Browse files
author
george
committed
proof edit css.md
1 parent 094b430 commit 12a9a65

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

app/docs/css.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Undernet's CSS is the backbone of the framework. It's written in a module format and precompiled using Sass.
1+
Undernet's CSS is the backbone of the framework. It's written in a module format with [Sass](https://sass-lang.com/).
22

33
The framework adopts a few conventions which help provide a predictable workflow.
44

@@ -16,21 +16,21 @@ Variables, functions, mixins, and classes each follow patterns to provide better
1616

1717
### Variables
1818

19-
All Sass variables have names with a pattern of: `grouping-noun-property-value-state`. `grouping` is the only piece consistent in every variable, with a combination of the rest, and always in the same order.
19+
All Sass variables have names with a pattern of: `grouping-noun-value-state`. `grouping` is the only piece consistent in every variable, with a combination of the rest, and always in the same order.
2020

2121
Here's a few examples:
2222

23-
- `$grid-padding`: Grouping = `grid`; Property = `padding`
24-
- `$type-p-margin-bottom`: Grouping = `type`; Noun = `p`; Property = `margin-bottom`
23+
- `$grid-padding`: Grouping = `grid`; Noun = `padding`
24+
- `$type-p-margin-bottom`: Grouping = `type`; Noun = `p`; Noun = `margin-bottom`
2525
- `$button-base-states`: Grouping = `button`; Noun = `base-states`
26-
- `$link-text-decoration-hover`: Grouping = `link`; Property = `text-decoration`; State = `hover`
27-
- `$modal-dialog-margin-narrow`: Grouping = `modal`; Noun = `container`; Property = `margin`; State = `narrow`
26+
- `$link-text-decoration-hover`: Grouping = `link`; Noun = `text-decoration`; State = `hover`
27+
- `$modal-dialog-margin-narrow`: Grouping = `modal-dialog`; Noun = `margin`; State = `narrow`
2828

29-
See the variables available in `_config.scss`.
29+
See the variables available in `_config.scss`, organized from global to component-specific.
3030

3131
### Functions
3232

33-
There are only a handful of functions. Each is written as `noun-value`. A function name always describes the thing it returns. E.g., `spacing-value` takes a size, such as `xs` or `lg`, and returns the value from the `$global-spacing-increments` map.
33+
There are only a handful of functions. Each is written as `noun-value`. Each function name always describes the thing it returns. E.g., `spacing-value` takes a size, such as `xs` or `lg`, and returns the value from the `$global-spacing-increments` map.
3434

3535
See the functions available in `utilities/_functions.scss`.
3636

@@ -45,11 +45,11 @@ See the mixins available in `utilities/_mixins.scss`.
4545
Classes are a bit more unique compared to variables or other Sass utilities. Classes take one of two flavors, a **Root** or a **Modifier**. They are named using a pattern similar to that of Sass variables.
4646

4747
- Root classes use nouns.
48-
- Modifier classes have the structure `verb-breakpoint-property-value-size`. A verb prefix is _always_ present. E.g., `is-*`, or `has-*`.
48+
- Modifier classes have the structure `verb-breakpoint-noun-value-size`. A verb prefix is _always_ present. E.g., `is-*`, or `has-*`.
4949

5050
#### Roots
5151

52-
As explained, a Root class describes an object, so it's a noun.
52+
As explained, a Root class describes an object, e.g. a noun.
5353

5454
Examples include `dropdown-menu`, `button`, or `grid`.
5555

@@ -67,7 +67,7 @@ Here's a few examples:
6767

6868
## Style Scope
6969

70-
Undernet has a special feature that helps you control where its styles are applied. When enabled, a scope will enforce that a pre-defined class exists around any elements using framework styling.
70+
Undernet has a special feature that helps you control where its styles are applied. When enabled, a scope will enforce that an element with a pre-defined class exists around any HTML in the document using framework styling.
7171

7272
As an example, let's say we enable the scope:
7373

0 commit comments

Comments
 (0)