Skip to content

Commit 45cc986

Browse files
committed
docs: update README and preview
1 parent ce4b720 commit 45cc986

File tree

6 files changed

+79
-16
lines changed

6 files changed

+79
-16
lines changed

README.md

Lines changed: 74 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,90 @@
1-
# Prism Github themes
2-
[![License](https://img.shields.io/badge/license-MIT-brightgreen?style=flat-square)](LICENSE) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/katorlys/prism-theme-github?style=flat-square)](https://github.com/katorlys/prism-theme-github/pulls) [![Issues](https://img.shields.io/github/issues-closed/katorlys/prism-theme-github?style=flat-square)](https://github.com/katorlys/prism-theme-github/issues) [![Lines](https://img.shields.io/tokei/lines/github/katorlys/prism-theme-github?style=flat-square)](https://github.com/katorlys/prism-theme-github) [![npm](https://img.shields.io/npm/v/prism-theme-github?style=flat-square)](https://www.npmjs.com/package/prism-theme-github)
3-
4-
Real Github themes for [Prism.js](https://prismjs.com). Themes based on [Github](https://github.com).
1+
<a name="readme-top"></a>
2+
<div align="center">
3+
4+
<!-- <a href="#">
5+
<img src="https://github.com/katorlys/.github/blob/main/assets/mark/mark.png" height="100">
6+
</a><br> -->
7+
8+
<h1>
9+
Prism Github themes
10+
</h1>
11+
12+
<p>
13+
Real Github themes for [Prism.js](https://prismjs.com).
14+
</p>
15+
16+
[![Pull Requests][github-pr-badge]][github-pr-link]
17+
[![Issues][github-issue-badge]][github-issue-link]
18+
[![License][github-license-badge]](LICENSE)
19+
20+
</div>
21+
22+
23+
<!-- Main Body -->
24+
25+
## Introduction
26+
Real Github themes for [Prism.js](https://prismjs.com).
27+
28+
Based on [Github](https://github.com).
29+
30+
531
## Themes
632
### Github Light
7-
[<img width="33%" src="/screenshots/github-light.png">](/themes/prism-theme-github-light.css)
33+
[![github-light-preview](screenshots/github-light.png)](/themes/prism-theme-github-light.css)
834
```html
935
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/katorlys/prism-theme-github/themes/prism-theme-github-light.css">
1036
```
1137

12-
1338
### Github Dark
14-
[<img width="33%" src="/screenshots/github-dark.png">](/themes/prism-theme-github-dark.css)
39+
[![github-dark-preview](screenshots/github-dark.png)](/themes/prism-theme-github-dark.css)
1540
```html
16-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/katorlys/prism-theme-github/themes/prism-theme-github-light.css">
41+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/katorlys/prism-theme-github/themes/prism-theme-github-dark.css">
1742
```
1843

1944
### Github Copilot
45+
[![github-copilot-preview](screenshots/github-copilot.png)](/themes/prism-theme-github-copilot.css)
2046
```html
2147
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/katorlys/prism-theme-github/themes/prism-theme-github-copilot.css">
22-
```
23-
48+
```
49+
50+
## Usage
51+
### CDN
52+
Embed the CDN links provided above to use the themes in your project.
2453

25-
You may want to get them from `npm`:
54+
### npmjs
55+
Or get the themes from npmjs:
2656
```sh
2757
npm install prism-theme-github
28-
```
58+
```
59+
60+
61+
<!-- /Main Body -->
62+
63+
64+
<div align="right">
65+
66+
[![BACK TO TOP][back-to-top-button]](#readme-top)
67+
68+
</div>
69+
70+
---
71+
72+
<div align="center">
73+
74+
<p>
75+
Copyright &copy; 2024-present <a target="_blank" href="https://github.com/katorlys">Katorly Lab</a>
76+
</p>
77+
78+
[![License][github-license-badge-bottom]](LICENSE)
79+
80+
</div>
81+
82+
[back-to-top-button]: https://img.shields.io/badge/BACK_TO_TOP-151515?style=flat-square
83+
[github-pr-badge]: https://img.shields.io/github/issues-pr/katorlys/prism-theme-github?label=pulls&labelColor=151515&color=79E096&style=flat-square
84+
[github-pr-link]: https://github.com/katorlys/prism-theme-github/pulls
85+
[github-issue-badge]: https://img.shields.io/github/issues/katorlys/prism-theme-github?labelColor=151515&color=FFC868&style=flat-square
86+
[github-issue-link]: https://github.com/katorlys/prism-theme-github/issues
87+
[github-license-badge]: https://img.shields.io/github/license/katorlys/prism-theme-github?labelColor=151515&color=EFEFEF&style=flat-square
88+
<!-- https://img.shields.io/badge/license-CC_BY--NC--SA_4.0-EFEFEF?labelColor=151515&style=flat-square -->
89+
[github-license-badge-bottom]: https://img.shields.io/github/license/katorlys/prism-theme-github?labelColor=151515&color=EFEFEF&style=for-the-badge
90+
<!-- https://img.shields.io/badge/license-CC_BY--NC--SA_4.0-EFEFEF?labelColor=151515&style=for-the-badge -->

package-lock.json

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

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "prism-theme-github",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"description": "Real Github themes for prism.js",
55
"main": "README.md",
66
"files": [
@@ -21,7 +21,8 @@
2121
"prism-theme",
2222
"prism-themes",
2323
"github-light",
24-
"github-dark"
24+
"github-dark",
25+
"github-copilot"
2526
],
2627
"author": "Katorly",
2728
"license": "MIT",

screenshots/github-copilot.png

18.5 KB
Loading

screenshots/github-dark.png

-21.2 KB
Loading

screenshots/github-light.png

-19.6 KB
Loading

0 commit comments

Comments
 (0)