doc(themes): update document. (#457)

uiwjs · Feb 10, 2023 · ee75999 · ee75999
1 parent 3e7707d
commit ee75999
Show file tree

Hide file tree

Showing 23 changed files with 72 additions and 30 deletions.
diff --git a/themes/abcdef/README.md b/themes/abcdef/README.md
@@ -38,7 +38,8 @@ import { abcdef, abcdefInit } from '@uiw/codemirror-theme-abcdef';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const abcdefInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsAbcdef: CreateThemeOptions['settings'];
+export declare const abcdefInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const abcdef: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/androidstudio/README.md b/themes/androidstudio/README.md
@@ -38,7 +38,10 @@ import { androidstudio, androidstudioInit } from '@uiw/codemirror-theme-androids
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const androidstudioInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsAndroidstudio: CreateThemeOptions['settings'];
+export declare const androidstudioInit: (
+  options?: Partial<CreateThemeOptions>,
+) => import('@codemirror/state').Extension;
 export declare const androidstudio: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/atomone/README.md b/themes/atomone/README.md
@@ -38,7 +38,8 @@ import { atomone, atomoneInit } from '@uiw/codemirror-theme-atomone';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const atomoneInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsAtomone: CreateThemeOptions['settings'];
+export declare const atomoneInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const atomone: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/aura/README.md b/themes/aura/README.md
@@ -38,7 +38,8 @@ import { aura, auraInit } from '@uiw/codemirror-theme-aura';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const auraInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsAura: CreateThemeOptions['settings'];
+export declare const auraInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const aura: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/bbedit/README.md b/themes/bbedit/README.md
@@ -38,7 +38,8 @@ import { bbedit, bbeditInit } from '@uiw/codemirror-theme-bbedit';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const bbeditInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsBbedit: CreateThemeOptions['settings'];
+export declare const bbeditInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const bbedit: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/bespin/README.md b/themes/bespin/README.md
@@ -38,7 +38,8 @@ import { bespin, bespinInit } from '@uiw/codemirror-theme-bespin';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const bespinInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsBespin: CreateThemeOptions['settings'];
+export declare const bespinInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const bespin: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/darcula/README.md b/themes/darcula/README.md
@@ -38,7 +38,8 @@ import { darcula, darculaInit } from '@uiw/codemirror-theme-darcula';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const darculaInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsDarcula: CreateThemeOptions['settings'];
+export declare const darculaInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const darcula: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/dracula/README.md b/themes/dracula/README.md
@@ -38,7 +38,8 @@ import { dracula, draculaInit } from '@uiw/codemirror-theme-dracula';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const draculaInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsDracula: CreateThemeOptions['settings'];
+export declare const draculaInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const dracula: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/duotone/README.md b/themes/duotone/README.md
@@ -38,9 +38,11 @@ import { duotoneLight, duotoneLightInit, duotoneDark, duotoneDarkInit } from '@u
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const duotoneLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsDuotoneLight: CreateThemeOptions['settings'];
+export declare const duotoneLightInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const duotoneLight: import('@codemirror/state').Extension;
-export declare const duotoneDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsDuotoneDark: CreateThemeOptions['settings'];
+export declare const duotoneDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const duotoneDark: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/eclipse/README.md b/themes/eclipse/README.md
@@ -34,7 +34,8 @@ import { eclipse, eclipseInit } from '@uiw/codemirror-theme-eclipse';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const eclipseInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsEclipse: CreateThemeOptions['settings'];
+export declare const eclipseInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const eclipse: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/github/README.md b/themes/github/README.md
@@ -38,9 +38,11 @@ import { githubLight, githubLightInit, githubDark, githubDarkInit } from '@uiw/c
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const githubLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsGithubLight: CreateThemeOptions['settings'];
+export declare const githubLightInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const githubLight: import('@codemirror/state').Extension;
-export declare const githubDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsGithubDark: CreateThemeOptions['settings'];
+export declare const githubDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const githubDark: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/gruvbox/README.md b/themes/gruvbox/README.md
@@ -40,9 +40,11 @@ import { gruvboxDark, gruvboxDarkInit, gruvboxLight, gruvboxLightInit } from '@u
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const gruvboxDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsGruvboxDark: CreateThemeOptions['settings'];
+export declare const gruvboxDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const gruvboxDark: import('@codemirror/state').Extension;
-export declare const gruvboxLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsGruvboxLight: CreateThemeOptions['settings'];
+export declare const gruvboxLightInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const gruvboxLight: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/material/README.md b/themes/material/README.md
@@ -43,11 +43,16 @@ import { materialDark, materialDarkInit, materialLight, materialLightInit } from
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const materialInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
-export declare const materialDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsMaterial: CreateThemeOptions['settings'];
+export declare const defaultSettingsMaterialDark: import('@uiw/codemirror-themes').Settings;
+export declare const materialInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
+export declare const materialDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const materialDark: import('@codemirror/state').Extension;
 export declare const material: import('@codemirror/state').Extension;
-export declare const materialLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsMaterialLight: CreateThemeOptions['settings'];
+export declare const materialLightInit: (
+  options?: Partial<CreateThemeOptions>,
+) => import('@codemirror/state').Extension;
 export declare const materialLight: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/noctis-lilac/README.md b/themes/noctis-lilac/README.md
@@ -36,7 +36,8 @@ import { noctisLilac, noctisLilacInit } from '@uiw/codemirror-theme-noctis-lilac
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const noctisLilacInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsNoctisLilac: CreateThemeOptions['settings'];
+export declare const noctisLilacInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const noctisLilac: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/nord/README.md b/themes/nord/README.md
@@ -36,7 +36,8 @@ import { nord, nordInit } from '@uiw/codemirror-theme-nord';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const nordInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsNord: CreateThemeOptions['settings'];
+export declare const nordInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const nord: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/okaidia/README.md b/themes/okaidia/README.md
@@ -34,7 +34,8 @@ import { okaidia, okaidiaInit } from '@uiw/codemirror-theme-okaidia';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const okaidiaInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsOkaidia: CreateThemeOptions['settings'];
+export declare const okaidiaInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const okaidia: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/solarized/README.md b/themes/solarized/README.md
@@ -40,9 +40,15 @@ import { solarizedLight, solarizedLightInit, solarizedDark, solarizedDarkInit }
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const solarizedLightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsSolarizedLight: CreateThemeOptions['settings'];
+export declare const solarizedLightInit: (
+  options?: Partial<CreateThemeOptions>,
+) => import('@codemirror/state').Extension;
 export declare const solarizedLight: import('@codemirror/state').Extension;
-export declare const solarizedDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsSolarizedDark: CreateThemeOptions['settings'];
+export declare const solarizedDarkInit: (
+  options?: Partial<CreateThemeOptions>,
+) => import('@codemirror/state').Extension;
 export declare const solarizedDark: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/sublime/README.md b/themes/sublime/README.md
@@ -34,7 +34,8 @@ import { sublime, sublimeInit } from '@uiw/codemirror-theme-sublime';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare function sublimeInit(options?: CreateThemeOptions): import('@codemirror/state').Extension;
+export declare const defaultSettingsSublime: CreateThemeOptions['settings'];
+export declare function sublimeInit(options?: Partial<CreateThemeOptions>): import('@codemirror/state').Extension;
 export declare const sublime: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/tokyo-night-day/README.md b/themes/tokyo-night-day/README.md
@@ -38,7 +38,10 @@ import { tokyoNightDay, tokyoNightDayInit } from '@uiw/codemirror-theme-tokyo-ni
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const tokyoNightDayInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsTokyoNightDay: CreateThemeOptions['settings'];
+export declare const tokyoNightDayInit: (
+  options?: Partial<CreateThemeOptions>,
+) => import('@codemirror/state').Extension;
 export declare const tokyoNightDay: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/tokyo-night-storm/README.md b/themes/tokyo-night-storm/README.md
@@ -38,7 +38,10 @@ import { tokyoNightStorm, tokyoNightStormInit } from '@uiw/codemirror-theme-toky
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const tokyoNightStormInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsTokyoNightStorm: CreateThemeOptions['settings'];
+export declare const tokyoNightStormInit: (
+  options?: Partial<CreateThemeOptions>,
+) => import('@codemirror/state').Extension;
 export declare const tokyoNightStorm: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/tokyo-night/README.md b/themes/tokyo-night/README.md
@@ -38,7 +38,8 @@ import { tokyoNight, tokyoNightInit } from '@uiw/codemirror-theme-tokyo-night';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare const tokyoNightInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsTokyoNight: CreateThemeOptions['settings'];
+export declare const tokyoNightInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const tokyoNight: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/vscode/README.md b/themes/vscode/README.md
@@ -34,7 +34,8 @@ import { vscodeDark, vscodeDarkInit } from '@uiw/codemirror-theme-vscode';
 
 ```tsx
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare function vscodeDarkInit(options?: CreateThemeOptions): import('@codemirror/state').Extension;
+export declare const defaultSettingsVscodeDark: CreateThemeOptions['settings'];
+export declare function vscodeDarkInit(options?: Partial<CreateThemeOptions>): import('@codemirror/state').Extension;
 export declare const vscodeDark: import('@codemirror/state').Extension;
 ```
 

diff --git a/themes/xcode/README.md b/themes/xcode/README.md
@@ -38,9 +38,11 @@ import { xcodeLight, xcodeLightInit, xcodeDark, xcodeDarkInit } from '@uiw/codem
 
 ```ts
 import { CreateThemeOptions } from '@uiw/codemirror-themes';
-export declare function xcodeLightInit(options?: CreateThemeOptions): import('@codemirror/state').Extension;
+export declare const defaultSettingsXcodeLight: CreateThemeOptions['settings'];
+export declare function xcodeLightInit(options?: Partial<CreateThemeOptions>): import('@codemirror/state').Extension;
 export declare const xcodeLight: import('@codemirror/state').Extension;
-export declare const xcodeDarkInit: (options?: CreateThemeOptions) => import('@codemirror/state').Extension;
+export declare const defaultSettingsXcodeDark: CreateThemeOptions['settings'];
+export declare const xcodeDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
 export declare const xcodeDark: import('@codemirror/state').Extension;
 ```