Skip to content

Commit

Permalink
Merge pull request #20 from HugoDF/patch-1
Browse files Browse the repository at this point in the history
docs: Add CDN install instructions
  • Loading branch information
adamwathan authored Jul 16, 2020
2 parents d806948 + 1974d1e commit 385f854
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ A plugin that provides a set of `prose` classes you can use to add beautiful typ
</article>
```

## Usage
## Installation


Install the plugin from npm:

Expand All @@ -39,6 +40,29 @@ module.exports = {
}
```

### Using a CDN

If you need to pull in these styles via CDN, you can do so using services like UNPKG or jsDeliver:

```html
<!-- From UNPKG -->
<link rel="stylesheet" href="https://unpkg.com/@tailwindcss/[email protected]/dist/typography.min.css">

<!-- From jsDelivr -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tailwindcss/[email protected]/dist/typography.min.css">
```

To use these styles alongside the rest of Tailwind via CDN, we recommend pulling in each layer separately so you can put the styles in the correct order:

```html
<link rel="stylesheet" href="https://unpkg.com/tailwindcss@^1.5/dist/base.min.css">
<link rel="stylesheet" href="https://unpkg.com/tailwindcss@^1.5/dist/components.min.css">
<link rel="stylesheet" href="https://unpkg.com/@tailwindcss/[email protected]/dist/typography.min.css">
<link rel="stylesheet" href="https://unpkg.com/tailwindcss@^1.5/dist/utilities.min.css">
```

## Usage

Now you can use the `prose` classes to add sensible typography styles to any vanilla HTML:

```html
Expand Down

0 comments on commit 385f854

Please sign in to comment.