@twind/typography

A Tailwind JS plugin for automatically styling plain HTML content with beautiful typographic defaults.

Usage no npm install needed!

<script type="module">
  import twindTypography from 'https://cdn.skypack.dev/@twind/typography';
</script>

README

@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 Latest Release Github Typescript Bundle Size

Installation

npm install @twind/typography

Usage

see @tailwindcss/typography

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. Feel free to open an issue 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

We are following the Conventional Commits 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