Skip to content

Commit

Permalink
docs: import readme into storybook
Browse files Browse the repository at this point in the history
  • Loading branch information
tillywoodfield committed Jun 4, 2024
1 parent 65bf88f commit 9fa2d4f
Showing 1 changed file with 4 additions and 33 deletions.
37 changes: 4 additions & 33 deletions src/start.mdx
Original file line number Diff line number Diff line change
@@ -1,36 +1,7 @@
import { Meta, Title } from "@storybook/blocks";
import { Markdown, Meta, Title } from "@storybook/blocks";

<Meta title="Get Started" />

<Title>IATI Design System</Title>

## Installation

There are multiple ways to use the IATI Design System CSS in your product:

### Option 1: CDN

1. Add a link to the CSS in the `<head>` section of your HTML page:
import ReadMe from "../README.md?raw";

```html
<head>
<link
href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/iati.min.css"
rel="stylesheet"
/>
</head>
```

### Option 2: NPM

1. Install the package with NPM:

```
npm install iati-design-system
```

2. The CSS can be imported from the following location:
<Meta title="Get Started" />

```javascript
import "iati-design-system/dist/css/iati.css";
```
<Markdown>{ReadMe}</Markdown>

0 comments on commit 9fa2d4f

Please sign in to comment.