@beamwind/core
Version:
compiles tailwind like shorthand syntax into css at runtime
72 lines (46 loc) • 3.89 kB
Markdown
# @beamwind/core
> compiles [Tailwind CSS] like shorthand syntax into CSS at runtime
[](https://github.com/kenoxa/beamwind/blob/main/LICENSE)
[](https://www.npmjs.com/package/@beamwind/core)
[](https://github.com/kenoxa/beamwind/blob/main/packages/core)
[](https://unpkg.com/browse/@beamwind/core/types/core.d.ts)
[](https://bundlephobia.com/result?p=@beamwind/core)
> [Read the docs](https://beamwind.js.org) |
> [API](https://beamwind.js.org/packages/core) |
> [Change Log](https://github.com/kenoxa/beamwind/blob/main/packages/core/CHANGELOG.md)
---
> The [core theme](https://github.com/kenoxa/beamwind/blob/main/packages/core/src/theme.js) is bare bones as most projects have their own colors, sizes, ... and naming system. You probably want use one of the following:
>
> - [beamwind](https://github.com/kenoxa/beamwind/blob/main/packages/beamwind) - using the [tailwind default theme](https://github.com/kenoxa/beamwind/blob/main/packages/preset-tailwind) and [preflight](https://github.com/kenoxa/beamwind/blob/main/packages/preflight)
> - [@beamwind/system](https://github.com/kenoxa/beamwind/blob/main/packages/system) - using a [semantic design system](https://github.com/kenoxa/beamwind/blob/main/packages/preset-system) and [preflight](https://github.com/kenoxa/beamwind/blob/main/packages/preflight)
> - [@beamwind/play](https://github.com/kenoxa/beamwind/blob/main/packages/play) - combining the [tailwind default theme](https://github.com/kenoxa/beamwind/blob/main/packages/preset-tailwind), the [semantic design system](https://github.com/kenoxa/beamwind/blob/main/packages/preset-system) and [preflight](https://github.com/kenoxa/beamwind/blob/main/packages/preflight) with [auto-conversion of unknown theme values](https://github.com/kenoxa/beamwind/blob/main/packages/preset-play)
---
<!-- prettier-ignore-start -->
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [Installation](#installation)
- [Contribute](#contribute)
- [License](#license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<!-- prettier-ignore-end -->
## Installation
```sh
npm install @beamwind/core
```
And then import it:
```js
import { bw } from '@beamwind/core'
```
> Please refer to the [main documentation](https://beamwind.js.org#usage) for further information.
## 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/kenoxa/beamwind). Feel free to [open an issue](https://github.com/kenoxa/beamwind/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.
### Sponsors
[](https://www.kenoxa.com) [Kenoxa GmbH](https://www.kenoxa.com)
## License
[MIT](https://github.com/kenoxa/beamwind/blob/main/LICENSE) © [Kenoxa GmbH](https://kenoxa.com)
[tailwind css]: https://tailwindcss.com
[oceanwind]: https://www.npmjs.com/package/oceanwind
[otion]: https://www.npmjs.com/package/otion