Skip to content

Commit 723d8b1

Browse files
committed
add tailwind github link
1 parent 1acfb54 commit 723d8b1

File tree

2 files changed

+10
-34
lines changed

2 files changed

+10
-34
lines changed

ui/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This is the front-end react source for [gitconvex](https://github.com/neel1996/g
99

1010
The depedency packages used by this project can be found [here](https://github.com/neel1996/gitconvex-ui/network/dependencies)
1111

12-
- **🎨 Styling** - For styling, the project uses [tailwind]() css framework
12+
- **🎨 Styling** - For styling, the project uses [tailwind](https://github.com/tailwindlabs/tailwindcss) css framework
1313
- **📑 Syntax Highlighting** - [prismjs](https://github.com/PrismJS/prism) is used for syntax highlighting within the *Git Difference* and *CodeView* section
1414
- **🎭 Icon set** - [FontAweomse for react](https://github.com/FortAwesome/Font-Awesome)
1515

@@ -27,7 +27,7 @@ After cloning the repo, follow the steps mentioned below to setup the react app,
2727

2828
- **Installing dependencies**
2929

30-
```
30+
``` shell
3131
$ cd gitconvex-ui
3232
$ npm install
3333
```
@@ -36,7 +36,7 @@ $ npm install
3636

3737
The project uses `tailwindcss v2.0.2` for styling all the elements, so it is mandatory to build the CSS file which is not included in the repo. Follow the steps to build the css file
3838

39-
```
39+
``` shell
4040

4141
$ cd gitconvex-ui
4242
$ npm install --global tailwindcss
@@ -46,6 +46,7 @@ $ npm run build:tailwind
4646
## This will generate a default tailwind css bundle
4747

4848
```
49+
4950
> **Note:** The final production build stage is configured to purge unused CSS selectors from the tailwind css file. So make sure you follow the [tailwind purge guidelines](https://tailwindcss.com/docs/controlling-file-size#writing-purgeable-html:~:text=Don't%20use%20string%20concatenation%20to%20create%20class%20names) to ensure that the required styles are included to the [production bundle](https://github.com/neel1996/gitconvex)
5051
5152
- **Starting the app**
@@ -55,7 +56,7 @@ After completing the setup process, use `npm start` to start the react app
5556

5657
## Project directory tree
5758

58-
```
59+
``` shell
5960
├── LICENSE
6061
├── README.md
6162
├── package-lock.json

ui/package-lock.json

Lines changed: 5 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)