-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: fix Remix setup doc #3725
base: main
Are you sure you want to change the base?
Conversation
@shihui-huang is attempting to deploy a commit to the shadcn-pro Team on Vercel. A member of the Team first needs to authorize it. |
need to install tailwind before running the `shadcn-ui` init command
### Install Tailwind CSS | ||
|
||
```bash | ||
npm add -D tailwindcss@latest autoprefixer@latest | ||
npx tailwindcss init |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
npx tailwindcss init | |
npx tailwindcss init --ts -p |
Official docs suggests to use TypeScript by default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because in the Configure components.json file, we've retained the option for the user to choose TypeScript or JavaScript, so I think we should also keep it here.
Just updated the docs like:
If you would like to use TypeScript (recommended), you can init Tailwind CSS like this:
npx tailwindcss init --ts -p
Otherwise, you can init Tailwind CSS without TypeScript like this:
npx tailwindcss init -p
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other parts of this docs seems outdated too (like the remix.config.js
). What do you think about suggesting to follow the tailwind installation steps (instead of retracing those steps here), then the ones related to shadcn-ui ?
Hi @alcpereira, I just updated the docs following the newest tailwind installation. |
Motivation
While following the Remix setup documentation, I encountered an error when executing the CLI on the second step. The error message is depicted in the image below:
It became apparent that the Tailwind CSS framework needs to be installed prior to executing the shadcn-ui initialization command.
Changes
To resolve this issue, I have reorganized the documentation to ensure that the Tailwind CSS installation section precedes the CLI execution section.