# Docus WindiCSS Module

> WindiCSS scanning compatible with Docus.

## Quick Setup

1. Add `@docus/windicss` dependency to your project:

```bash
# Using Yarn
yarn add --dev @docus/windicss
# Using NPM
npm install --save-dev @docus/windicss
```

2. Add `@docus/windicss` to the `buildModules` section of your `nuxt.config.js`

```typescript
{
  buildModules: ['@docus/windicss']
}
```

## Usage

1. Add a `windi.config.{js|ts}` file at the root of your `themeDir`.
2. Write your `windi.config` file as you would usually do.
3. It gets merged with the user Windi config (`rootDir/windi.config`) file.
4. You also get full scanning of Windi classes into [Span Syntax](https://docus.dev/writing/syntax#span-text).

## Development

1. Clone this repository
2. Install dependencies using `yarn install`
3. Start dev server using `yarn dev`