Skip to content

Commit ae54860

Browse files
committed
Update README.md
1 parent af7af00 commit ae54860

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# craft-vue-tailwind
2+
23
Fork of the [craft-vue](https://github.com/chasegiunta/craft-vue) template that integrates the Tailwind CSS utility framework & removes unused CSS with Purgecss.
34

45
## What's Included
56

67
- `npm run dev` / `yarn dev`: first-in-class development experience.
8+
79
- Webpack + `vue-loader` for single file Vue components
810
- State preserving hot-reload
911
- Page reloading on file edits (twig, html, etc)
@@ -27,9 +29,7 @@ You should fork this repo to create your own boilerplate. This scaffold makes no
2729

2830
This boilerplate requires Vue CLI 3 be [installed globally on your machine](https://cli.vuejs.org/guide/installation.html).
2931

30-
31-
32-
``` bash
32+
```bash
3333
# create & install project
3434
composer create-project chasegiunta/craft-vue-tailwind PATH
3535

@@ -68,26 +68,27 @@ After running `npm run build`, the easiest way to test your build files locally
6868

6969
For a detailed explanation on how things work, check out the [Vue CLI docs](https://cli.vuejs.org/).
7070

71-
## Tailwind directives in .vue files
72-
73-
Using Tailwind directives (@apply, etc.) inside of Vue's single file components is now possible with the addition of an expirimental `shadowLookup` flag enabled in your tailwind.js file (added in Tailwind v0.6.2 - hooray!).
74-
7571
## Pre-Processors
7672

7773
This boilerplate has pre-configured CSS extraction for most popular CSS pre-processors including LESS, SASS, Stylus, and PostCSS. To use a pre-processor, all you need to do is install the appropriate webpack loader for it. For example, to use SASS:
78-
``` bash
74+
75+
```bash
7976
npm install sass-loader node-sass --save-dev
8077
# yarn add sass-loader node-sass --dev
8178
```
79+
8280
Note you also need to install node-sass because sass-loader depends on it as a peer dependency.
8381

8482
Read more about this at https://cli.vuejs.org/guide/css.html#pre-processors
8583

8684
## Automatic Component Registration
85+
8786
Any vue components placed within `src/components` will be registered with Vue automatically. **This requires their filenames to be in PascalCase**, eg. MyVueComponent.vue
8887

8988
## Babel Compiling
89+
9090
This boilerplate uses babel-preset-env for configuring babel. [You can read more about it here.](https://cli.vuejs.org/config/#babel)
9191

9292
## Linting
93+
9394
You can enable linting by adding the `@vue/cli-plugin-eslint` plugin through the GUI `vue ui`.

0 commit comments

Comments
 (0)