# @twind/typography

> A plugin that provides a set of `prose` classes you can use to add beautiful typographic defaults to any vanilla HTML you don't control (like HTML rendered from Markdown, or pulled from a CMS).

[![MIT License](https://flat.badgen.net/github/license/tw-in-js/typography)](https://github.com/tw-in-js/typography/blob/main/LICENSE)
[![Latest Release](https://flat.badgen.net/npm/v/@twind/typography?icon=npm&label)](https://www.npmjs.com/package/@twind/typography)
[![Github](https://flat.badgen.net/badge/icon/tw-in-js%2Ftypography?icon=github&label)](https://github.com/tw-in-js/typography)
[![Typescript](https://flat.badgen.net/badge/icon/included?icon=typescript&label)](https://unpkg.com/browse/@twind/typography/types/index.d.ts)
[![Bundle Size](https://flat.badgen.net/bundlephobia/minzip/@twind/typography?icon=packagephobia&label&color=blue)](https://bundlephobia.com/result?p=@twind/typography)

---

- [Installation](#installation)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)

## Installation

```sh
npm install @twind/typography
```

## Usage

> see [@tailwindcss/typography](https://github.com/tailwindlabs/tailwindcss-typography)

```js
import typography from '@twind/typography'
import { setup } from 'twind'

setup({
  plugins: {
    ...typography({
      className: 'my-prose', // Defaults to 'prose'
    }),
  },
})
```

## Contribute

Thanks for being willing to contribute!

> This project is free and open-source, so if you think this project can help you or anyone else, you may [star it on GitHub](https://github.com/tw-in-js/typography). Feel free to [open an issue](https://github.com/tw-in-js/typography/issues) if you have any idea, question, or you've found a bug.

**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

We are following the [Conventional Commits](https://www.conventionalcommits.org) convention.

### Develop

> Ensure you run at least Node v14.

Clone the repository and cd into the project directory.

Run `yarn install && yarn build`.

- `yarn format`: Ensure consistent code style
- `yarn build`: Build the package
- `yarn start`: Start example using snowpack
- `yarn release`: To publish the package

## License

[MIT](https://github.com/tw-in-js/typography/blob/main/LICENSE)