Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chee authored Oct 4, 2023
1 parent 51847e8 commit e4f5a50
Showing 1 changed file with 1 addition and 10 deletions.
11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ content as an abstract tree. It implements the **[unist][unist]** spec.
- [Types](#types)
- [Mixins](#mixins)
- [Nodes](#nodes)
- [TODO](#todo)
- [License](#license)

## Introduction
Expand Down Expand Up @@ -551,8 +550,6 @@ interface ScrollySection extends Parent {

**ScrollySection** represents a section of a [ScrollyBlock](#scrollyblock)

- TODO: could `transition` have a `"none"` value so it isn't optional?

### `ScrollyImage`

```ts
Expand All @@ -573,8 +570,6 @@ interface ScrollyCopy extends Parent {
}
```

TODO is this badly named?

**ScrollyCopy** represents a collection of **ScrollyHeading** or **Paragraph** nodes.

```ts
Expand All @@ -599,14 +594,10 @@ interface Layout extends Parent {
```

**Layout** nodes are a generic component used to display a combination of other
nodes (usually headings, images and paragraphs) in a visually distinctive way.
nodes (headings, images and paragraphs) in a visually distinctive way.

The `layoutName` acts as a sort of theme for the component.

TODO: Editorial actually have named / well-defined components that all publish
as layouts (InfoBox, Comparison, ImagePair, Timeline etc). At some point in the
future, we should try and define these.

### `LayoutSlot`


Expand Down

0 comments on commit e4f5a50

Please sign in to comment.