Skip to content

Commit ee75999

Browse files
committedFeb 10, 2023
doc(themes): update document. (#457)
1 parent 3e7707d commit ee75999

File tree

23 files changed

+72
-30
lines changed

23 files changed

+72
-30
lines changed
 

‎themes/abcdef/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ import { abcdef, abcdefInit } from '@uiw/codemirror-theme-abcdef';
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const abcdefInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsAbcdef: CreateThemeOptions['settings'];
42+
export declare const abcdefInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const abcdef: import('@codemirror/state').Extension;
4344
```
4445

‎themes/androidstudio/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ import { androidstudio, androidstudioInit } from '@uiw/codemirror-theme-androids
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const androidstudioInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsAndroidstudio: CreateThemeOptions['settings'];
42+
export declare const androidstudioInit: (
43+
options?: Partial<CreateThemeOptions>,
44+
) => import('@codemirror/state').Extension;
4245
export declare const androidstudio: import('@codemirror/state').Extension;
4346
```
4447

‎themes/atomone/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ import { atomone, atomoneInit } from '@uiw/codemirror-theme-atomone';
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const atomoneInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsAtomone: CreateThemeOptions['settings'];
42+
export declare const atomoneInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const atomone: import('@codemirror/state').Extension;
4344
```
4445

‎themes/aura/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ import { aura, auraInit } from '@uiw/codemirror-theme-aura';
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const auraInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsAura: CreateThemeOptions['settings'];
42+
export declare const auraInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const aura: import('@codemirror/state').Extension;
4344
```
4445

‎themes/bbedit/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ import { bbedit, bbeditInit } from '@uiw/codemirror-theme-bbedit';
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const bbeditInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsBbedit: CreateThemeOptions['settings'];
42+
export declare const bbeditInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const bbedit: import('@codemirror/state').Extension;
4344
```
4445

‎themes/bespin/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ import { bespin, bespinInit } from '@uiw/codemirror-theme-bespin';
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const bespinInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsBespin: CreateThemeOptions['settings'];
42+
export declare const bespinInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const bespin: import('@codemirror/state').Extension;
4344
```
4445

‎themes/darcula/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ import { darcula, darculaInit } from '@uiw/codemirror-theme-darcula';
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const darculaInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsDarcula: CreateThemeOptions['settings'];
42+
export declare const darculaInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const darcula: import('@codemirror/state').Extension;
4344
```
4445

‎themes/dracula/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ import { dracula, draculaInit } from '@uiw/codemirror-theme-dracula';
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const draculaInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsDracula: CreateThemeOptions['settings'];
42+
export declare const draculaInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const dracula: import('@codemirror/state').Extension;
4344
```
4445

‎themes/duotone/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,11 @@ import { duotoneLight, duotoneLightInit, duotoneDark, duotoneDarkInit } from '@u
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const duotoneLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsDuotoneLight: CreateThemeOptions['settings'];
42+
export declare const duotoneLightInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const duotoneLight: import('@codemirror/state').Extension;
43-
export declare const duotoneDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
44+
export declare const defaultSettingsDuotoneDark: CreateThemeOptions['settings'];
45+
export declare const duotoneDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4446
export declare const duotoneDark: import('@codemirror/state').Extension;
4547
```
4648

‎themes/eclipse/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ import { eclipse, eclipseInit } from '@uiw/codemirror-theme-eclipse';
3434

3535
```tsx
3636
import { CreateThemeOptions } from '@uiw/codemirror-themes';
37-
export declare const eclipseInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
37+
export declare const defaultSettingsEclipse: CreateThemeOptions['settings'];
38+
export declare const eclipseInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
3839
export declare const eclipse: import('@codemirror/state').Extension;
3940
```
4041

‎themes/github/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,11 @@ import { githubLight, githubLightInit, githubDark, githubDarkInit } from '@uiw/c
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const githubLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsGithubLight: CreateThemeOptions['settings'];
42+
export declare const githubLightInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const githubLight: import('@codemirror/state').Extension;
43-
export declare const githubDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
44+
export declare const defaultSettingsGithubDark: CreateThemeOptions['settings'];
45+
export declare const githubDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4446
export declare const githubDark: import('@codemirror/state').Extension;
4547
```
4648

‎themes/gruvbox/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,11 @@ import { gruvboxDark, gruvboxDarkInit, gruvboxLight, gruvboxLightInit } from '@u
4040

4141
```tsx
4242
import { CreateThemeOptions } from '@uiw/codemirror-themes';
43-
export declare const gruvboxDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
43+
export declare const defaultSettingsGruvboxDark: CreateThemeOptions['settings'];
44+
export declare const gruvboxDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4445
export declare const gruvboxDark: import('@codemirror/state').Extension;
45-
export declare const gruvboxLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
46+
export declare const defaultSettingsGruvboxLight: CreateThemeOptions['settings'];
47+
export declare const gruvboxLightInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4648
export declare const gruvboxLight: import('@codemirror/state').Extension;
4749
```
4850

‎themes/material/README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,16 @@ import { materialDark, materialDarkInit, materialLight, materialLightInit } from
4343

4444
```tsx
4545
import { CreateThemeOptions } from '@uiw/codemirror-themes';
46-
export declare const materialInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
47-
export declare const materialDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
46+
export declare const defaultSettingsMaterial: CreateThemeOptions['settings'];
47+
export declare const defaultSettingsMaterialDark: import('@uiw/codemirror-themes').Settings;
48+
export declare const materialInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
49+
export declare const materialDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4850
export declare const materialDark: import('@codemirror/state').Extension;
4951
export declare const material: import('@codemirror/state').Extension;
50-
export declare const materialLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
52+
export declare const defaultSettingsMaterialLight: CreateThemeOptions['settings'];
53+
export declare const materialLightInit: (
54+
options?: Partial<CreateThemeOptions>,
55+
) => import('@codemirror/state').Extension;
5156
export declare const materialLight: import('@codemirror/state').Extension;
5257
```
5358

‎themes/noctis-lilac/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ import { noctisLilac, noctisLilacInit } from '@uiw/codemirror-theme-noctis-lilac
3636

3737
```tsx
3838
import { CreateThemeOptions } from '@uiw/codemirror-themes';
39-
export declare const noctisLilacInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
39+
export declare const defaultSettingsNoctisLilac: CreateThemeOptions['settings'];
40+
export declare const noctisLilacInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4041
export declare const noctisLilac: import('@codemirror/state').Extension;
4142
```
4243

‎themes/nord/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ import { nord, nordInit } from '@uiw/codemirror-theme-nord';
3636

3737
```tsx
3838
import { CreateThemeOptions } from '@uiw/codemirror-themes';
39-
export declare const nordInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
39+
export declare const defaultSettingsNord: CreateThemeOptions['settings'];
40+
export declare const nordInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4041
export declare const nord: import('@codemirror/state').Extension;
4142
```
4243

‎themes/okaidia/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ import { okaidia, okaidiaInit } from '@uiw/codemirror-theme-okaidia';
3434

3535
```tsx
3636
import { CreateThemeOptions } from '@uiw/codemirror-themes';
37-
export declare const okaidiaInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
37+
export declare const defaultSettingsOkaidia: CreateThemeOptions['settings'];
38+
export declare const okaidiaInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
3839
export declare const okaidia: import('@codemirror/state').Extension;
3940
```
4041

‎themes/solarized/README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,15 @@ import { solarizedLight, solarizedLightInit, solarizedDark, solarizedDarkInit }
4040

4141
```tsx
4242
import { CreateThemeOptions } from '@uiw/codemirror-themes';
43-
export declare const solarizedLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
43+
export declare const defaultSettingsSolarizedLight: CreateThemeOptions['settings'];
44+
export declare const solarizedLightInit: (
45+
options?: Partial<CreateThemeOptions>,
46+
) => import('@codemirror/state').Extension;
4447
export declare const solarizedLight: import('@codemirror/state').Extension;
45-
export declare const solarizedDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
48+
export declare const defaultSettingsSolarizedDark: CreateThemeOptions['settings'];
49+
export declare const solarizedDarkInit: (
50+
options?: Partial<CreateThemeOptions>,
51+
) => import('@codemirror/state').Extension;
4652
export declare const solarizedDark: import('@codemirror/state').Extension;
4753
```
4854

‎themes/sublime/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ import { sublime, sublimeInit } from '@uiw/codemirror-theme-sublime';
3434

3535
```tsx
3636
import { CreateThemeOptions } from '@uiw/codemirror-themes';
37-
export declare function sublimeInit(options?: CreateThemeOptions): import('@codemirror/state').Extension;
37+
export declare const defaultSettingsSublime: CreateThemeOptions['settings'];
38+
export declare function sublimeInit(options?: Partial<CreateThemeOptions>): import('@codemirror/state').Extension;
3839
export declare const sublime: import('@codemirror/state').Extension;
3940
```
4041

‎themes/tokyo-night-day/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ import { tokyoNightDay, tokyoNightDayInit } from '@uiw/codemirror-theme-tokyo-ni
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const tokyoNightDayInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsTokyoNightDay: CreateThemeOptions['settings'];
42+
export declare const tokyoNightDayInit: (
43+
options?: Partial<CreateThemeOptions>,
44+
) => import('@codemirror/state').Extension;
4245
export declare const tokyoNightDay: import('@codemirror/state').Extension;
4346
```
4447

‎themes/tokyo-night-storm/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ import { tokyoNightStorm, tokyoNightStormInit } from '@uiw/codemirror-theme-toky
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const tokyoNightStormInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsTokyoNightStorm: CreateThemeOptions['settings'];
42+
export declare const tokyoNightStormInit: (
43+
options?: Partial<CreateThemeOptions>,
44+
) => import('@codemirror/state').Extension;
4245
export declare const tokyoNightStorm: import('@codemirror/state').Extension;
4346
```
4447

‎themes/tokyo-night/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ import { tokyoNight, tokyoNightInit } from '@uiw/codemirror-theme-tokyo-night';
3838

3939
```tsx
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare const tokyoNightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
41+
export declare const defaultSettingsTokyoNight: CreateThemeOptions['settings'];
42+
export declare const tokyoNightInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4243
export declare const tokyoNight: import('@codemirror/state').Extension;
4344
```
4445

‎themes/vscode/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ import { vscodeDark, vscodeDarkInit } from '@uiw/codemirror-theme-vscode';
3434

3535
```tsx
3636
import { CreateThemeOptions } from '@uiw/codemirror-themes';
37-
export declare function vscodeDarkInit(options?: CreateThemeOptions): import('@codemirror/state').Extension;
37+
export declare const defaultSettingsVscodeDark: CreateThemeOptions['settings'];
38+
export declare function vscodeDarkInit(options?: Partial<CreateThemeOptions>): import('@codemirror/state').Extension;
3839
export declare const vscodeDark: import('@codemirror/state').Extension;
3940
```
4041

‎themes/xcode/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,11 @@ import { xcodeLight, xcodeLightInit, xcodeDark, xcodeDarkInit } from '@uiw/codem
3838

3939
```ts
4040
import { CreateThemeOptions } from '@uiw/codemirror-themes';
41-
export declare function xcodeLightInit(options?: CreateThemeOptions): import('@codemirror/state').Extension;
41+
export declare const defaultSettingsXcodeLight: CreateThemeOptions['settings'];
42+
export declare function xcodeLightInit(options?: Partial<CreateThemeOptions>): import('@codemirror/state').Extension;
4243
export declare const xcodeLight: import('@codemirror/state').Extension;
43-
export declare const xcodeDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
44+
export declare const defaultSettingsXcodeDark: CreateThemeOptions['settings'];
45+
export declare const xcodeDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
4446
export declare const xcodeDark: import('@codemirror/state').Extension;
4547
```
4648

0 commit comments

Comments
 (0)
Please sign in to comment.