Skip to content

Commit 25efb79

Browse files
committed
docs: markdownlint
1 parent 9462228 commit 25efb79

File tree

1 file changed

+49
-36
lines changed

1 file changed

+49
-36
lines changed

readme.md

Lines changed: 49 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
1-
<div align="center"><p><a href="https://www.codefactor.io/repository/github/krishdevdb/reseter.css"><img src="https://img.shields.io/codefactor/grade/github/krishdevdb/reseter.css?style=flat-square&logo=codefactor"></a> <a href="https://bundlephobia.com/result?p=reseter.css"><img src="https://img.shields.io/bundlephobia/minzip/reseter.css?style=flat-square"></a> <a href="#-contributors"><img src="https://img.shields.io/github/all-contributors/krishdevdb/reseter.css?style=flat-square&logo=github"></a></p><img height="100px" width="100px" src="https://github.com/krishdevdb/reseter.css/raw/master/logo.png"><br><h1>Reseter.css</h1><h5>A Futuristic Alternative to Normalize.css and CSS Resets</h5><a href="https://twitter.com/intent/tweet?url=https://github.com/krishdevdb/reseter.css&text=Reseter.css%20helped%20me%20out%20in%20my%20website%20by%20normalizing%20everything.%20And%20Reseting%20The%20Browser%20Default%20Styles.%20Now%20My%20Website%20Looks%20The%20Same%20Across%20All%20Browsers"><img alt="Twitter URL" src="https://img.shields.io/twitter/url?color=%23ffffff00&logo=twitter&style=for-the-badge&url=https%3A%2F%2Fgithub.com%2Fkrishdevdb%2Freseter.css"></a><br><p><img src="https://github.com/krishdevdb/reseter.css/raw/master/.github/assets/showcase.png" height="400"></p><p><a href="https://krishdevdb.github.io/reseter.css">Website</a> · <a href="https://github.com/krishdevdb/reseter.css/issues/new?assignees=krishdevdb%27&labels=feature+request&template=feature-request.md&title=Request%3A+">Request a Feature</a> · <a href="https://github.com/krishdevdb/reseter.css/issues/new?assignees=krishdevdb&labels=bug&template=bug-report.md&title=Bug%3A+">Report a Bug</a></p></div><br>
1+
# Reseter.css
2+
3+
![Reseter.css Logo](https://github.com/krishdevdb/reseter.css/raw/master/logo.png)
4+
5+
## Normalizing but better
6+
7+
[![Code Quality](https://img.shields.io/codefactor/grade/github/krishdevdb/reseter.css?style=flat-square&logo=codefactor)](https://www.codefactor.io/repository/github/krishdevdb/reseter.css)
8+
9+
[![Bundle Size](https://img.shields.io/bundlephobia/minzip/reseter.css?style=flat-square)](https://bundlephobia.com/result?p=reseter.css)
10+
11+
[![Twitter URL](https://img.shields.io/twitter/url?color=%23ffffff00&logo=twitter&style=for-the-badge&url=https%3A%2F%2Fgithub.com%2Fkrishdevdb%2Freseter.css)](https://twitter.com/intent/tweet?url=https://github.com/krishdevdb/reseter.css&text=Reseter.css%20helped%20me%20out%20in%20my%20website%20by%20normalizing%20everything.%20And%20Reseting%20The%20Browser%20Default%20Styles.%20Now%20My%20Website%20Looks%20The%20Same%20Across%20All%20Browsers)
12+
13+
![Reseter.css Preview](https://github.com/krishdevdb/reseter.css/raw/master/.github/assets/showcase.png)
14+
15+
[Website](https://krishdevdb.github.io/reseter.css) · [Request a Feature](https://github.com/krishdevdb/reseter.css/issues/new?assignees=krishdevdb%27&labels=feature+request&template=feature-request.md&title=Request%3A+) · [Report a Bug](https://github.com/krishdevdb/reseter.css/issues/new?assignees=krishdevdb&labels=bug&template=bug-report.md&title=Bug%3A+)
216

317
## 🤓 Benefits
418

5-
* [x] No need to start from scratch. Reseter.css doesn't remove all the browser styles, but instead redifines the useful ones
6-
* [x] Never switch preprocessors/technologies. `sass`, `less`, `scss`, `stylus`, and `styled-components` support available.
7-
* [x] Never find yourself fixing browser issues. **Includes browser fixes** for a wide range of browsers.
8-
* [x] No need debugging load time for Reseter.css. It's **sized ~0.7kb**. Moreover, we are consistently trying to reduce it.
9-
* [x] Get **all the benefits of normalize.css**. It includes all normalizations!
10-
* [x] Get a better box sizing for a better experience. `box-sing: border-box` set
11-
* [x] Completely production ready code with **browser support testing** and **source build ci**
19+
* [x] No need to start from scratch. Reseter.css doesn't remove all the browser styles, but instead redifines the useful ones
20+
* [x] Never switch preprocessors/technologies. `sass`, `less`, `scss`, `stylus`, and `styled-components` support available.
21+
* [x] Never find yourself fixing browser issues. **Includes browser fixes** for a wide range of browsers.
22+
* [x] No need debugging load time for Reseter.css. It's **sized ~0.7kb**. Moreover, we are consistently trying to reduce it.
23+
* [x] Get **all the benefits of normalize.css**. It includes all normalizations!
24+
* [x] Get a better box sizing for a better experience. `box-sing: border-box` set
25+
* [x] Completely production ready code with **browser support testing** and **source build ci**
1226

1327
## ❓ Why do I use a css reset
1428

1529
There are many inconsistencies between browsers. Like Firefox 3 has a margin on top of paragraphs but Internet Explorer 7 doesn't have any margin. There are thousands of browsers with hundreds of versions. Each version at least has 500+ inconsitencies with different browsers' different versions. How to keep up? This is an easy to use solution called **reseter.css**
1630

17-
<img align="center" alt="Browser Inconsistencies" src="https://github.com/krishdevdb/reseter.css/raw/master/.github/assets/css_reset.png">
31+
![Browser Inconsistencies](https://github.com/krishdevdb/reseter.css/raw/master/.github/assets/css_reset.png)
1832

1933
## 🆚 There are other resets, why reseter.css?
2034

@@ -26,7 +40,7 @@ There are many inconsistencies between browsers. Like Firefox 3 has a margin on
2640
| Minified version | ![npm bundle size](https://img.shields.io/bundlephobia/min/reseter.css?style=flat-square) | ❌ (Minify yourself) | ❌(Minify yourself) | ❌(Minify yourself) |
2741
| GZIP version | ![npm bundle size](https://img.shields.io/bundlephobia/minzip/reseter.css?style=flat-square) | ❌ (Compress yourself) | ❌ (Compress yourself) | ❌ (Compress yourself) |
2842
| Box sizing |||||
29-
| Browser support | Last 5 versions <br />All not dead Browsers <br />**Customisable** | IE 10+<br />Safari 8+<br />Chrome<br />Firefox ESR+<br />Opera<br />Edge | Last 3 versions<br />Exception: safari last 2<br />Also firefox ESR, IE 9+ | Unkown |
43+
| Browser support | Customizable | Last 3 versions | Last 3 versions | Unknown |
3044

3145
## 🚀 Get It Running Quick
3246

@@ -46,11 +60,14 @@ There are many inconsistencies between browsers. Like Firefox 3 has a margin on
4660
</body>
4761
</html>
4862
```
63+
4964
3. Call Reseter.css
65+
5066
```html
5167
<!-- To be placed in the head tag -->
5268
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/reseter.css" />
5369
```
70+
5471
4. Star this repository, if you like the project! It means a lot to the development team, Those stars a boosting happiness for our team
5572

5673
5. How about reading a guide for best performance? Here's the link to [optimizing reseter.css for production](#-optimize)
@@ -61,37 +78,38 @@ There are many inconsistencies between browsers. Like Firefox 3 has a margin on
6178

6279
## 📚 Quick Templates
6380

64-
- [CodeSandBox](https://codesandbox.io/s/resetercss-26kzw)
81+
* [CodeSandBox](https://codesandbox.io/s/resetercss-26kzw)
6582

66-
- [CodePen](https://codepen.io/krishdevdb/pen/XWppdvK)
83+
* [CodePen](https://codepen.io/krishdevdb/pen/XWppdvK)
6784

68-
- More soon...
85+
* More soon...
6986

7087
## 🌟 Installation
7188

7289
There are various ways to install reseter.css. Like package managers, content delivery networks, local copies...
7390

7491
### 📦 Package Managers
7592

76-
#### 💝 **NPM** ![](https://img.shields.io/npm/dt/reseter.css?style=flat-square)
93+
#### 💝 **NPM** ![Npm Downloads](https://img.shields.io/npm/dt/reseter.css?style=flat-square)
7794

7895
```bash
7996
npm install reseter.css
8097
```
8198

82-
#### 🐱**Yarn** ![](https://img.shields.io/npm/dt/reseter.css?style=flat-square)
99+
#### 🐱**Yarn** ![Yarn Downloads](https://img.shields.io/npm/dt/reseter.css?style=flat-square)
83100

84101
```bash
85102
yarn add reseter.css
86103
```
87104

88-
### ⚡ CDN ![](https://img.shields.io/jsdelivr/npm/hy/reseter.css?style=flat-square)
105+
### ⚡ CDN ![CDN Hits](https://img.shields.io/jsdelivr/npm/hy/reseter.css?style=flat-square)
89106

90107
```html
91108
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/reseter.css" />
92109
```
93110

94-
## ✨ Get Using It
111+
## ✨ Usage
112+
95113
Reseter.css as said, is a zero-dependency project and excels in integrating with all kinds of usage options! These are a few easy guides for people to start
96114

97115
```html
@@ -110,23 +128,24 @@ Reseter.css as said, is a zero-dependency project and excels in integrating with
110128
> Make Sure To Link Your Custom Stylesheet After Reseter.css Else Your Custom Styles Might Not Be Implemented
111129
112130
### ✨ More
113-
- [**🐍 Django**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-django)
114-
- [**⚛ ReactJs**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-reactjs)
115-
- [**✌️ Vuejs**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-vuejs)
116-
- [**⏭ Next.js**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-nextjs)
117-
- [**💅 Styled Components**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-styled-components)
131+
132+
* [**🐍 Django**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-django)
133+
* [**⚛ ReactJs**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-reactjs)
134+
* [**✌️ Vuejs**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-vuejs)
135+
* [**⏭ Next.js**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-nextjs)
136+
* [**💅 Styled Components**](https://github.com/krishdevdb/reseter.css/wiki/Usage#-styled-components)
118137

119138
## 🚅 Optimize
120139

121140
> **Note** all of these guidelines are for static websites, frameworks like react have their own guide (please refer them)
122141
123-
- Never import reseter.css via css, though this a option, it is not recommended for website loading, rather use html link tags
142+
* Never import reseter.css via css, though this a option, it is not recommended for website loading, rather use html link tags
124143

125144
```html
126145
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/reseter.css">
127146
```
128147

129-
- Use this easy loading trick to make your life a lot easier
148+
* Use this easy loading trick to make your life a lot easier
130149

131150
```html
132151
<link rel="preload" as="style" href="https://cdn.jsdelivr.net/npm/reseter.css" onload="this.rel='stylesheet';this.onload=null">
@@ -136,14 +155,14 @@ Reseter.css as said, is a zero-dependency project and excels in integrating with
136155
</noscript>
137156
```
138157

139-
- Find more at [our wiki](https://github.com/krishdevdb/reseter.css/wiki/Performance)
158+
* Find more at [our wiki](https://github.com/krishdevdb/reseter.css/wiki/Performance)
140159

141160
## 📞 We're Ready To Support
142161

143-
- [ ] Discord server (Coming Soon)
144-
- [x] [GitHub discussions](https://github.com/krishdevdb/reseter.css/discussions)
145-
- [x] [Stackoverflow](https://stackoverflow.com/questions/ask?tags=resetercss%20css%20webdev)
146-
- [x] [Bug handler](https://github.com/krishdevdb/reseter.css/issues)
162+
* [ ] Discord server (Coming Soon)
163+
* [x] [GitHub discussions](https://github.com/krishdevdb/reseter.css/discussions)
164+
* [x] [Stack overflow](https://stackoverflow.com/questions/ask?tags=resetercss%20css%20webdev)
165+
* [x] [Bug handler](https://github.com/krishdevdb/reseter.css/issues)
147166

148167
## ⌚ Roadmap
149168

@@ -157,10 +176,4 @@ Reseter.css as said, is a zero-dependency project and excels in integrating with
157176
158177
## ❤ Thanks to our supporters
159178

160-
<a href="https://github.com/krishdevdb/reseter.css/stargazers">
161-
<img src="https://reporoster.com/stars/krishdevdb/reseter.css">
162-
</a>
163-
164-
## ⌚ Status
165-
166-
This project is currently being **maintained**. Please Consider [Donating](https://opencollective.com/resetercss/).
179+
[![GitHub Stargazers](https://reporoster.com/stars/krishdevdb/reseter.css)](https://github.com/krishdevdb/reseter.css/stargazers)

0 commit comments

Comments
 (0)