diff options
Diffstat (limited to 'examples/with-tailwind/README.md')
| -rw-r--r-- | examples/with-tailwind/README.md | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/examples/with-tailwind/README.md b/examples/with-tailwind/README.md deleted file mode 100644 index 2b95be1..0000000 --- a/examples/with-tailwind/README.md +++ /dev/null @@ -1,51 +0,0 @@ -# Turborepo Tailwind CSS starter - -This is an official starter Turborepo. - -## Using this example - -Run the following command: - -```sh -npx create-turbo@latest -e with-tailwind -``` - -## What's inside? - -This Turborepo includes the following packages/apps: - -### Apps and Packages - -- `docs`: a [Next.js](https://nextjs.org/) app with [Tailwind CSS](https://tailwindcss.com/) -- `web`: another [Next.js](https://nextjs.org/) app with [Tailwind CSS](https://tailwindcss.com/) -- `ui`: a stub React component library with [Tailwind CSS](https://tailwindcss.com/) shared by both `web` and `docs` applications -- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) -- `tsconfig`: `tsconfig.json`s used throughout the monorepo - -Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). - -### Building packages/ui - -This example is setup to build `packages/ui` and output the transpiled source and compiled styles to `dist/`. This was chosen to make sharing one `tailwind.config.js` as easy as possible, and to ensure only the CSS that is used by the current application and its dependencies is generated. - -Another option is to consume `packages/ui` directly from source without building. If using this option, you will need to update your `tailwind.config.js` to be aware of your package locations, so it can find all usages of the `tailwindcss` class names. - -For example, in [tailwind.config.js](packages/tailwind-config/tailwind.config.js): - -```js - content: [ - // app content - `src/**/*.{js,ts,jsx,tsx}`, - // include packages if not transpiling - "../../packages/**/*.{js,ts,jsx,tsx}", - ], -``` - -### Utilities - -This Turborepo has some additional tools already setup for you: - -- [Tailwind CSS](https://tailwindcss.com/) for styles -- [TypeScript](https://www.typescriptlang.org/) for static type checking -- [ESLint](https://eslint.org/) for code linting -- [Prettier](https://prettier.io) for code formatting |