Skip to content
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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

shihui-huang
Copy link

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:
image

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.

Copy link

vercel bot commented May 11, 2024

@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.

@shihui-huang shihui-huang changed the title docs: fix remix setup doc docs: fix Remix setup doc May 11, 2024
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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
npx tailwindcss init
npx tailwindcss init --ts -p

Official docs suggests to use TypeScript by default.

Copy link
Author

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

apps/www/content/docs/installation/remix.mdx Outdated Show resolved Hide resolved
Copy link

@alcpereira alcpereira left a 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 ?

@shihui-huang
Copy link
Author

shihui-huang commented May 12, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants