0.0.1 • Published 3 years ago
@tw-in-js/typography v0.0.1
@tw-in-js/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).
Installation
npm install @tw-in-js/typography
Usage
import typography from '@tw-in-js/typography'
import { setup } from '@tw-in-js/core'
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 test
: Run test suite including lintingyarn format
: Ensure consistent code styleyarn build
: Build the packageyarn release
: To publish the package
License
0.0.1
3 years ago