docs: added themes preview (#115)
* Adding themes.md file * Update and rename THEMES.md to README.md * Added link to theme preview README * Removed Dark/Light sections, combined into 1 table * Update README.md * Updated "Add your theme" link to open in edit mode
This commit is contained in:
		
							parent
							
								
									8fc85c68b1
								
							
						
					
					
						commit
						9fb28c9112
					
				
					 2 changed files with 63 additions and 1 deletions
				
			
		| 
						 | 
				
			
			@ -83,7 +83,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr
 | 
			
		|||
 | 
			
		||||
<img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="Github Readme Stat Themes" width="600px"/>
 | 
			
		||||
 | 
			
		||||
Check out more themes at [theme config file](./themes/index.js) & **you can also contribute new themes** if you like :D
 | 
			
		||||
You can look at a preview for [all available themes](./themes/README.md) or checkout the [theme config file](./themes/index.js) & **you can also contribute new themes** if you like :D
 | 
			
		||||
 | 
			
		||||
### Customization
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										62
									
								
								themes/README.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										62
									
								
								themes/README.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,62 @@
 | 
			
		|||
## Available Themes
 | 
			
		||||
 | 
			
		||||
With inbuilt themes you can customize the look of the card without doing any manual customization.
 | 
			
		||||
 | 
			
		||||
Use `?theme=THEME_NAME` parameter like so :-
 | 
			
		||||
 | 
			
		||||
```md
 | 
			
		||||
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=dark&show_icons=true
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Stats
 | 
			
		||||
 | 
			
		||||
> These themes work both for the Stats Card and Repo Card.
 | 
			
		||||
 | 
			
		||||
|                               |                                        |                                              |
 | 
			
		||||
| :---------------------------: | :------------------------------------: | :------------------------------------------: |
 | 
			
		||||
| `default` ![default][default] |     `radical` ![radical][radical]      |           `merko` ![merko][merko]            |
 | 
			
		||||
| `gruvbox` ![gruvbox][gruvbox] | `tokyonight` ![tokyonight][tokyonight] |        `onedark` ![onedark][onedark]         |
 | 
			
		||||
|  `cobalt` ![cobalt][cobalt]   |  `synthwave` ![synthwave][synthwave]   | `highcontrast` ![highcontrast][highcontrast] |
 | 
			
		||||
| `dracula` ![dracula][dracula] |          `dark` ![dark][dark]          |         [Add your theme][add-theme]          |
 | 
			
		||||
 | 
			
		||||
## Repo Card
 | 
			
		||||
 | 
			
		||||
> These themes work both for the Stats Card and Repo Card.
 | 
			
		||||
 | 
			
		||||
|                                                          |                                                 |                                                       |
 | 
			
		||||
| :------------------------------------------------------: | :---------------------------------------------: | :---------------------------------------------------: |
 | 
			
		||||
| `default_repocard` ![default_repocard][default_repocard] |     `radical` ![radical][radical_repocard]      |           `merko` ![merko][merko_repocard]            |
 | 
			
		||||
|          `gruvbox` ![gruvbox][gruvbox_repocard]          | `tokyonight` ![tokyonight][tokyonight_repocard] |        `onedark` ![onedark][onedark_repocard]         |
 | 
			
		||||
|           `cobalt` ![cobalt][cobalt_repocard]            |  `synthwave` ![synthwave][synthwave_repocard]   | `highcontrast` ![highcontrast][highcontrast_repocard] |
 | 
			
		||||
|          `dracula` ![dracula][dracula_repocard]          |     `dark` ![dark_repocard][dark_repocard]      |              [Add your theme][add-theme]              |
 | 
			
		||||
 | 
			
		||||
<!-- Repo Card Theme previews -->
 | 
			
		||||
 | 
			
		||||
[default_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=default_repocard
 | 
			
		||||
[dark_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=dark
 | 
			
		||||
[radical_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=radical
 | 
			
		||||
[merko_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=merko
 | 
			
		||||
[gruvbox_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=gruvbox
 | 
			
		||||
[cobalt_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=cobalt
 | 
			
		||||
[dark_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=dark
 | 
			
		||||
[dracula_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=dracula
 | 
			
		||||
[tokyonight_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=tokyonight
 | 
			
		||||
[synthwave_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=synthwave
 | 
			
		||||
[onedark_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=onedark
 | 
			
		||||
[highcontrast_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=highcontrast
 | 
			
		||||
 | 
			
		||||
<!-- Stats Theme previews -->
 | 
			
		||||
 | 
			
		||||
[default]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=default&hide=["contribs","prs"]
 | 
			
		||||
[dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=dark&hide=["contribs","prs"]
 | 
			
		||||
[radical]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=radical&hide=["contribs","prs"]
 | 
			
		||||
[merko]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=merko&hide=["contribs","prs"]
 | 
			
		||||
[gruvbox]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=gruvbox&hide=["contribs","prs"]
 | 
			
		||||
[tokyonight]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=tokyonight&hide=["contribs","prs"]
 | 
			
		||||
[onedark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=onedark&hide=["contribs","prs"]
 | 
			
		||||
[cobalt]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=cobalt&hide=["contribs","prs"]
 | 
			
		||||
[synthwave]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=synthwave&hide=["contribs","prs"]
 | 
			
		||||
[highcontrast]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=highcontrast&hide=["contribs","prs"]
 | 
			
		||||
[dracula]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=dracula&hide=["contribs","prs"]
 | 
			
		||||
 | 
			
		||||
[add-theme]: https://github.com/anuraghazra/github-readme-stats/edit/master/themes/index.js
 | 
			
		||||
		Loading…
	
	Add table
		
		Reference in a new issue