https://github.com/anooprav7/custom-tailwindcss-docs
Documentation of a custom tailwindcss configuration
https://github.com/anooprav7/custom-tailwindcss-docs
tailwindcss tailwindcss-utility
Last synced: 2 months ago
JSON representation
Documentation of a custom tailwindcss configuration
- Host: GitHub
- URL: https://github.com/anooprav7/custom-tailwindcss-docs
- Owner: anooprav7
- Created: 2021-02-14T13:52:12.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-22T14:47:56.000Z (over 5 years ago)
- Last Synced: 2025-04-07T06:32:47.703Z (about 1 year ago)
- Topics: tailwindcss, tailwindcss-utility
- Language: JavaScript
- Homepage: https://custom-tailwindcss-docs.vercel.app/
- Size: 156 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Custom tailwindcss config documentation
Generate the documentation of all the CSS classes generated with a custom tailwindcss config.
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
Location of tailwindcss config - `src/constants/customTailwindConfig`
## Features
1. Shows the status of the plugin ( Enabled/ Disbled ).
Eg. I have disabled `float` and `clear` plugins as i do not want to use them. So in the Sidebar and details page of `float` and `clear`, it shows disabled so that i don't accidently try to use them.
2. Generated tailwindcss config is also shown
Shows the tailwindcss config provided and also the generated final config (after merging with the default config) used to generate the CSS classes. Eg. https://custom-tailwindcss-docs.vercel.app/config
3. The CSS classes can be copied on click to the clipboard from the Class Table for all plugins
4. Variants available for each plugin are shown on the plugin page.
## Getting Started
First, run the development server:
```bash
npm run dev
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## TODO
```
1. animation, preflight, container plugin generation not available
```