Skip to content

Commit

Permalink
Update truncate and view READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
sarayourfriend committed Jan 25, 2021
1 parent 8a9b450 commit 4bc5092
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 78 deletions.
35 changes: 0 additions & 35 deletions packages/components/src/truncate/README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,7 @@
---
title: Truncate
description: 'Truncate is a typography primitive that trims text content.'
type: typography
slug: /components/truncate/
keywords: ['truncate', 'text', 'ellipsis', 'trim', 'clip']
---

# Truncate

`Truncate` is a typography primitive that trims text content. For almost all cases, it is recommended that `Text`, `Heading`, or `Subheading` is used to render text content. However, `Truncate` is available for custom implementations.

## Table of contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Usage](#usage)
- [Props](#props)
- [See Also](#see-also)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<!-- Automatically Generated. DO NOT EDIT THIS FILE. -->
<!-- Instead, edit packages/website/src/docs/components/typography/truncate.mdx -->

<!-- props -->

<!-- Automatically Generated -->

## Usage

```jsx live
Expand Down Expand Up @@ -90,12 +64,3 @@ function Example() {
);
}
```

<!-- /Automatically Generated -->
<!-- /props -->

## See Also

- [`Text`](../text/)
- [`Heading`](../heading/)
- [`Subheading`](../subheading/)
43 changes: 0 additions & 43 deletions packages/components/src/view/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,9 @@
---
title: View
description: 'View is the core component that renders everything in the library. It is the principle component in the entire library.'
type: layout
slug: /components/view/
keywords: ['view', 'base', 'div', 'box', 'core', 'element', 'ui']
---

# View

`View` is a core component that renders everything in the library. It is the principle component in the entire library. Note that `View` is not exported from components, it's fully internal.

**Everything** is a `View`, and a `View` is **everything**.

## Table of contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Usage](#usage)
- [Props](#props)
- [Styling](#styling)
- [Presets](#presets)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<!-- Automatically Generated. DO NOT EDIT THIS FILE. -->
<!-- Instead, edit packages/website/src/docs/components/core/view.mdx -->

<!-- props -->

<!-- Automatically Generated -->

## Usage

```jsx live
Expand All @@ -47,13 +20,6 @@ function Example() {

## Props

##### \_\_\_css

**Type**: `InterpolatedCSS`

Render custom CSS using the style system. The `cx` prop combines custom styling with the `css` prop.
Typically used "internally" to establish based styles for a `View`.

##### as

**Type**: `string`,`E`
Expand All @@ -66,15 +32,6 @@ Render the component as another React Component or HTML Element.

Render custom CSS using the style system.

##### cx

**Type**: `any`

Combines classNames as well as CSS style rules created with the `css` function.

<!-- /Automatically Generated -->
<!-- /props -->

## Styling

### Presets
Expand Down

0 comments on commit 4bc5092

Please sign in to comment.