@fsegurai/codemirror-theme-gruvbox-light 6.0.7 → 6.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +105 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,28 +1,115 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img alt="CodeMirror 6 Themes Logo" src="https://raw.githubusercontent.com/fsegurai/codemirror-themes/main/demo/public/codemirror-themes.png">
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="https://github.com/fsegurai/codemirror-themes/actions/workflows/release-library.yml">
|
|
7
|
+
<img src="https://github.com/fsegurai/codemirror-themes/actions/workflows/release-library.yml/badge.svg"
|
|
8
|
+
alt="Build Status">
|
|
9
|
+
</a>
|
|
10
|
+
<a href="https://www.npmjs.org/package/@fsegurai/codemirror-theme-gruvbox-light">
|
|
11
|
+
<img src="https://img.shields.io/npm/v/@fsegurai/codemirror-theme-gruvbox-light.svg"
|
|
12
|
+
alt="Latest Release">
|
|
13
|
+
</a>
|
|
14
|
+
<br>
|
|
15
|
+
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/fsegurai/codemirror-themes">
|
|
16
|
+
<img alt="Dependency status for repo" src="https://img.shields.io/librariesio/github/fsegurai/codemirror-themes">
|
|
17
|
+
<a href="https://opensource.org/licenses/MIT">
|
|
18
|
+
<img alt="GitHub License" src="https://img.shields.io/github/license/fsegurai/codemirror-themes">
|
|
19
|
+
</a>
|
|
20
|
+
<br>
|
|
21
|
+
<img alt="Stars" src="https://img.shields.io/github/stars/fsegurai/codemirror-themes?style=square&labelColor=343b41"/>
|
|
22
|
+
<img alt="Forks" src="https://img.shields.io/github/forks/fsegurai/codemirror-themes?style=square&labelColor=343b41"/>
|
|
23
|
+
</p>
|
|
4
24
|
|
|
5
|
-
|
|
25
|
+
**A library of custom themes for CodeMirror 6.**
|
|
6
26
|
|
|
7
|
-
|
|
8
|
-
[CodeMirror](https://codemirror.net/6/) code editor.
|
|
27
|
+
`@fsegurai/codemirror-theme-gruvbox-light` is a theme for CodeMirror 6 editor, making it visually engaging and adaptable to different coding styles and user preferences.
|
|
9
28
|
|
|
10
|
-
|
|
11
|
-
number of [examples](https://codemirror.net/6/examples/) and the
|
|
12
|
-
[documentation](https://codemirror.net/6/docs/).
|
|
29
|
+
### Table of contents
|
|
13
30
|
|
|
14
|
-
|
|
15
|
-
[
|
|
31
|
+
- [Installation](#installation)
|
|
32
|
+
- [@fsegurai/codemirror-theme-gruvbox-light](#fseguraicodemirror-theme-gruvbox-light)
|
|
33
|
+
- [Using Theme](#using-theme)
|
|
34
|
+
- [Available Themes](#available-themes)
|
|
35
|
+
- [Demo Application](#demo-application)
|
|
36
|
+
- [License](#license)
|
|
16
37
|
|
|
17
|
-
|
|
18
|
-
we have a [code of
|
|
19
|
-
conduct](http://contributor-covenant.org/version/1/1/0/) that applies
|
|
20
|
-
to communication around the project.
|
|
38
|
+
## Installation
|
|
21
39
|
|
|
22
|
-
|
|
40
|
+
### @fsegurai/codemirror-theme-gruvbox-light
|
|
23
41
|
|
|
24
|
-
|
|
42
|
+
To add `@fsegurai/codemirror-theme-gruvbox-light` along with CodeMirror 6 to your `package.json` use the following commands.
|
|
25
43
|
|
|
26
|
-
|
|
44
|
+
```bash
|
|
45
|
+
npm install @fsegurai/codemirror-theme-gruvbox-light codemirror@^6.0.0 --save
|
|
46
|
+
```
|
|
27
47
|
|
|
28
|
-
|
|
48
|
+
### Using Theme
|
|
49
|
+
|
|
50
|
+
Import the respective theme from the package and apply it to your CodeMirror instance as shown below.
|
|
51
|
+
|
|
52
|
+
```javascript
|
|
53
|
+
import { EditorView, basicSetup } from 'codemirror'
|
|
54
|
+
import { markdown } from '@codemirror/lang-markdown'
|
|
55
|
+
import { gruvboxLight } from '@fsegurai/codemirror-theme-basic-gruvbox-light'
|
|
56
|
+
|
|
57
|
+
let editor = new EditorView({
|
|
58
|
+
doc: '# Hello World',
|
|
59
|
+
extensions: [
|
|
60
|
+
basicSetup,
|
|
61
|
+
markdown(),
|
|
62
|
+
gruvboxLight
|
|
63
|
+
],
|
|
64
|
+
parent: document.body
|
|
65
|
+
})
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Read the [CodeMirror documentation](https://codemirror.net/6/examples/styling/) for more details about themes.
|
|
69
|
+
|
|
70
|
+
### Available Themes
|
|
71
|
+
|
|
72
|
+
- [All - Bundle](./packages/bundle)
|
|
73
|
+
- [Abcdef](./packages/abcdef)
|
|
74
|
+
- [Abyss](./packages/abyss)
|
|
75
|
+
- [Android Studio](./packages/android-studio)
|
|
76
|
+
- [Andromeda](./packages/andromeda)
|
|
77
|
+
- [Basic Dark](./packages/basic-dark)
|
|
78
|
+
- [Basic Light](./packages/basic-light)
|
|
79
|
+
- [Forest](./packages/forest)
|
|
80
|
+
- [GitHub Dark](./packages/github-dark)
|
|
81
|
+
- [GitHub Light](./packages/github-light)
|
|
82
|
+
- [Gruvbox Dark](./packages/gruvbox-dark)
|
|
83
|
+
- [Gruvbox Light](./packages/gruvbox-light)
|
|
84
|
+
- [Material Dark](./packages/material-dark)
|
|
85
|
+
- [Material Light](./packages/material-light)
|
|
86
|
+
- [Monokai](./packages/monokai)
|
|
87
|
+
- [Nord](./packages/nord)
|
|
88
|
+
- [Palenight](./packages/palenight)
|
|
89
|
+
- [Solarized Dark](./packages/solarized-dark)
|
|
90
|
+
- [Solarized Light](./packages/solarized-light)
|
|
91
|
+
- [Tokyo Night Day](./packages/tokyo-night-day)
|
|
92
|
+
- [Tokyo Night Storm](./packages/tokyo-night-storm)
|
|
93
|
+
- [Volcano](./packages/volcano)
|
|
94
|
+
- [VS Code Dark](./packages/vscode-dark)
|
|
95
|
+
- [VS Code Light](./packages/vscode-light)
|
|
96
|
+
|
|
97
|
+
For a full list, see the [<code>@fsegurai/codemirror-theme-bundle</code>](https://github.com/fsegurai/codemirror-themes/tree/main/packages/bundle) directory or the online demo.
|
|
98
|
+
|
|
99
|
+
### Demo Application
|
|
100
|
+
|
|
101
|
+
To see all themes in action, check out the demo: [https://fsegurai.github.io/codemirror-themes](https://fsegurai.github.io/codemirror-themes).
|
|
102
|
+
|
|
103
|
+
To set up the demo locally:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
git clone https://github.com/fsegurai/codemirror-themes.git
|
|
107
|
+
npm install
|
|
108
|
+
npm start
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
This will serve the application locally at [http://[::1]:8000](http://[::1]:8000).
|
|
112
|
+
|
|
113
|
+
## License
|
|
114
|
+
|
|
115
|
+
Licensed under [MIT](https://opensource.org/licenses/MIT).
|