@alik6/bun-tailwind-plugin

Tailwind Plugin for Bun

The Tailwind Plugin for Bun is a plugin designed to integrate Tailwind CSS with the Bun. This plugin simplifies the process of using Tailwind CSS within your Bun projects, allowing you to easily compile Tailwind CSS files during the build process.

Installation

You can install the Tailwind Plugin via Bun:

bun install @alik6/bun-tailwind-plugin

Usage

Importing

import { tailwind } from "@alik6/bun-tailwind-plugin";

Configuration

import { tailwind } from "@alik6/bun-tailwind-plugin";
import { build } from "bun";

build({
  entrypoints: ["src/main.tsx"],
  // If not explicitly set in 'outputFile', defaults to 'outdir/' if defined, otherwise 'dist/'.
  outdir: "dist/",
  plugins: [
    tailwind({
      // tailwind Configuration
      tailwindConfig: { content: ["src/**/*.{tsx,html}"] },
      // path for output css file
      outputFile: "dist/styles.css",
      // path of input file, created if not found with the default tailwind headers
      inputFile: "src/styles.css",
      // path where tailwind.config.js will be generated, useful for autocompletion, each time the build method is called the tailwind.config.js will be synced with `tailwindConfig`, recommended path is 'base dir of the project'
      configPath: '.'
    }),
  ],
}).catch((e) => console.error(e));

Contributing to @alik6/bun-tailwind-plugin

Welcome to @alik6/bun-tailwind-plugin, We appreciate your interest in contributing.

Ways to Contribute

• Reporting Bugs: If you encounter a bug, please open an issue on GitHub and provide detailed information about the problem, including steps to reproduce it.

• Requesting Features: If you have an idea for a new feature or enhancement, you can submit a feature request on GitHub. Provide a clear description of the proposed feature and its use case.

• Submitting Pull Requests: If you'd like to contribute code, you can fork the repository, create a new branch, and submit a pull request with your changes. Please ensure that your code adheres to our coding standards and include relevant tests.

Getting Started

To get started with contributing, follow these steps:

• Fork the repository on GitHub.

• Clone your forked repository to your local machine.

• Create a new branch for your changes (git checkout -b feature/my-feature).

• Make your changes and commit them (git commit -am 'Add my feature').

• Push your changes to your forked repository (git push origin feature/my-feature).

• Submit a pull request on GitHub.

License

By contributing to @alik6/bun-tailwind-plugin, you agree that your contributions will be licensed under the MIT License.