@rspress/shared 0.0.0-nightly-20231107160249 → 0.0.0-nightly-20231108160202
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/dist/index.d.ts +8 -5
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -183,13 +183,13 @@ type Image = string | {
|
|
|
183
183
|
alt?: string;
|
|
184
184
|
};
|
|
185
185
|
interface Sidebar {
|
|
186
|
-
[path: string]: (SidebarGroup | SidebarItem)[];
|
|
186
|
+
[path: string]: (SidebarGroup | SidebarItem | SidebarDivider)[];
|
|
187
187
|
}
|
|
188
188
|
interface SidebarGroup {
|
|
189
189
|
text: string;
|
|
190
190
|
link?: string;
|
|
191
191
|
tag?: string;
|
|
192
|
-
items: (SidebarItem | SidebarGroup | string)[];
|
|
192
|
+
items: (SidebarItem | SidebarDivider | SidebarGroup | string)[];
|
|
193
193
|
collapsible?: boolean;
|
|
194
194
|
collapsed?: boolean;
|
|
195
195
|
}
|
|
@@ -198,6 +198,9 @@ type SidebarItem = {
|
|
|
198
198
|
link: string;
|
|
199
199
|
tag?: string;
|
|
200
200
|
};
|
|
201
|
+
type SidebarDivider = {
|
|
202
|
+
dividerType: 'dashed' | 'solid';
|
|
203
|
+
};
|
|
201
204
|
interface EditLink {
|
|
202
205
|
/**
|
|
203
206
|
* Custom repository url for edit link.
|
|
@@ -240,12 +243,12 @@ interface LocaleLink {
|
|
|
240
243
|
link: string;
|
|
241
244
|
}
|
|
242
245
|
interface NormalizedSidebarGroup extends Omit<SidebarGroup, 'items'> {
|
|
243
|
-
items: (SidebarItem | NormalizedSidebarGroup)[];
|
|
246
|
+
items: (SidebarDivider | SidebarItem | NormalizedSidebarGroup)[];
|
|
244
247
|
collapsible: boolean;
|
|
245
248
|
collapsed: boolean;
|
|
246
249
|
}
|
|
247
250
|
interface NormalizedSidebar {
|
|
248
|
-
[path: string]: (NormalizedSidebarGroup | SidebarItem)[];
|
|
251
|
+
[path: string]: (NormalizedSidebarGroup | SidebarItem | SidebarDivider)[];
|
|
249
252
|
}
|
|
250
253
|
interface NormalizedLocales extends Omit<LocaleConfig, 'sidebar'> {
|
|
251
254
|
sidebar: NormalizedSidebar;
|
|
@@ -705,4 +708,4 @@ declare function removeBase(url: string, base: string): string;
|
|
|
705
708
|
declare function withoutHash(url: string): string;
|
|
706
709
|
declare const mergeDocConfig: (...configs: UserConfig[]) => UserConfig;
|
|
707
710
|
|
|
708
|
-
export { APPEARANCE_KEY, AdditionalPage, BaseRuntimePageInfo, Config, Config$1 as DefaultThemeConfig, DocFooter, EditLink, Feature, Footer, FrontMatterMeta, HASH_REGEXP, Header, Hero, Image, LocalSearchOptions, Locale, LocaleConfig, LocaleLink, LocaleLinks, MDX_REGEXP, MarkdownOptions, Nav, NavItem, NavItemWithChildren, NavItemWithLink, NavItemWithLinkAndChildren, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, RemotePageInfo, RemoteSearchIndexInfo, RemoteSearchOptions, ReplaceRule, Route, RouteMeta, RouteOptions, RspressPlugin, SEARCH_INDEX_NAME, SearchHooks, SearchOptions, Sidebar, SidebarGroup, SidebarItem, SiteData, SocialLink, SocialLinkIcon, UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };
|
|
711
|
+
export { APPEARANCE_KEY, AdditionalPage, BaseRuntimePageInfo, Config, Config$1 as DefaultThemeConfig, DocFooter, EditLink, Feature, Footer, FrontMatterMeta, HASH_REGEXP, Header, Hero, Image, LocalSearchOptions, Locale, LocaleConfig, LocaleLink, LocaleLinks, MDX_REGEXP, MarkdownOptions, Nav, NavItem, NavItemWithChildren, NavItemWithLink, NavItemWithLinkAndChildren, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, RemotePageInfo, RemoteSearchIndexInfo, RemoteSearchOptions, ReplaceRule, Route, RouteMeta, RouteOptions, RspressPlugin, SEARCH_INDEX_NAME, SearchHooks, SearchOptions, Sidebar, SidebarDivider, SidebarGroup, SidebarItem, SiteData, SocialLink, SocialLinkIcon, UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };
|