@rspress/shared 2.0.0-rc.5 → 2.0.0-rc.7

package/dist/index.d.ts

@@ -33,6 +33,13 @@ export declare interface EditLink {
 }
 
 export declare interface Feature {
+    /**
+     * Feature icon, supports:
+     * - Emoji: '🚀'
+     * - HTML string: '<span class="icon">...</span>'
+     * - SVG string: '<svg>...</svg>'
+     * - Image URL: '/icons/feature.svg' or 'https://example.com/icon.png'
+     */
     icon: string;
     title: string;
     details: string;
@@ -127,6 +134,9 @@ export declare interface I18nText {
     languagesText?: I18nTextValue;
     versionsText?: I18nTextValue;
     themeText?: I18nTextValue;
+    copyMarkdownText?: I18nTextValue;
+    copyMarkdownLinkText?: I18nTextValue;
+    openInText?: I18nTextValue;
     menuTitle?: I18nTextValue;
     outlineTitle?: I18nTextValue;
     scrollToTopText?: I18nTextValue;
@@ -165,6 +175,33 @@ export declare function isExternalUrl(url?: string): boolean;
 
 export declare const isProduction: () => boolean;
 
+/**
+ * Configuration for LLMS UI components displayed on H1 headers.
+ * When enabled, LlmsCopyButton and LlmsViewOptions will be automatically
+ * added below H1 headers without requiring custom getCustomMDXComponent.
+ * @default false
+ */
+export declare type LlmsUI = {
+    /**
+     * Options for LlmsViewOptions component dropdown menu.
+     * @default ['markdownLink', 'chatgpt', 'claude']
+     */
+    viewOptions?: LlmsViewOption[];
+} | boolean;
+
+/**
+ * Option item for LlmsViewOptions component.
+ */
+export declare type LlmsViewOption = 'markdownLink' | 'chatgpt' | 'claude' | {
+    title: string;
+    icon?: React.ReactNode;
+    onClick?: () => void;
+} | {
+    title: string;
+    href: string;
+    icon?: React.ReactNode;
+};
+
 export declare interface Locale {
     lang: string;
     label: string;
@@ -226,6 +263,12 @@ export declare interface MarkdownOptions {
      * @default true
      */
     crossCompilerCache?: boolean;
+    /**
+     * Whether to automatically extract a description from the markdown content,
+     * typically from the first paragraph, for use in page metadata or previews.
+     * @default true
+     */
+    extractDescription?: boolean;
 }
 
 export declare const matchNavbar: (item: NavItemWithLink, currentPathname: string) => boolean;
@@ -322,8 +365,8 @@ export declare interface PageIndexInfo {
     title: string;
     toc: Header[];
     content: string;
+    description?: string;
     _flattenContent?: string;
-    _html: string;
     frontmatter: FrontMatterMeta;
     lang: string;
     version: string;
@@ -620,6 +663,7 @@ export declare interface SiteData {
         light: string;
     };
     logoText: string;
+    logoHref: string;
     search: SearchOptions;
     markdown: {
         showLineNumbers: boolean;
@@ -719,6 +763,12 @@ declare type ThemeConfig = {
      * @default true
      */
     fallbackHeadingTitle?: boolean;
+    /**
+     * LLMS UI components configuration.
+     * When llmsUI.enableOnH1 is true, LlmsCopyButton and LlmsViewOptions
+     * will be automatically added below H1 headers.
+     */
+    llmsUI?: LlmsUI;
 };
 export { ThemeConfig as DefaultThemeConfig }
 export { ThemeConfig }
@@ -741,6 +791,11 @@ export declare interface UserConfig {
      * @default ''
      */
     logoText?: string;
+    /**
+     * Custom link for the logo.
+     * @default '/${lang}/'
+     */
+    logoHref?: string;
     /**
      * Base path of the site.
      * @default '/'

package/dist/node-utils.d.ts

@@ -32,6 +32,13 @@ declare interface EditLink {
 export declare const extractTextAndId: (title?: string) => [text: string, customId: string];
 
 declare interface Feature {
+    /**
+     * Feature icon, supports:
+     * - Emoji: '🚀'
+     * - HTML string: '<span class="icon">...</span>'
+     * - SVG string: '<svg>...</svg>'
+     * - Image URL: '/icons/feature.svg' or 'https://example.com/icon.png'
+     */
     icon: string;
     title: string;
     details: string;
@@ -132,6 +139,9 @@ declare interface I18nText {
     languagesText?: I18nTextValue;
     versionsText?: I18nTextValue;
     themeText?: I18nTextValue;
+    copyMarkdownText?: I18nTextValue;
+    copyMarkdownLinkText?: I18nTextValue;
+    openInText?: I18nTextValue;
     menuTitle?: I18nTextValue;
     outlineTitle?: I18nTextValue;
     scrollToTopText?: I18nTextValue;
@@ -158,6 +168,33 @@ declare type I18nTextValue = {
     [key: string]: string;
 };
 
+/**
+ * Configuration for LLMS UI components displayed on H1 headers.
+ * When enabled, LlmsCopyButton and LlmsViewOptions will be automatically
+ * added below H1 headers without requiring custom getCustomMDXComponent.
+ * @default false
+ */
+declare type LlmsUI = {
+    /**
+     * Options for LlmsViewOptions component dropdown menu.
+     * @default ['markdownLink', 'chatgpt', 'claude']
+     */
+    viewOptions?: LlmsViewOption[];
+} | boolean;
+
+/**
+ * Option item for LlmsViewOptions component.
+ */
+declare type LlmsViewOption = 'markdownLink' | 'chatgpt' | 'claude' | {
+    title: string;
+    icon?: React.ReactNode;
+    onClick?: () => void;
+} | {
+    title: string;
+    href: string;
+    icon?: React.ReactNode;
+};
+
 export declare function loadFrontMatter<TFrontmatter extends Record<string, unknown> = FrontMatterMeta>(source: string, filepath: string, root: string, outputWarning?: boolean): {
     frontmatter: TFrontmatter;
     content: string;
@@ -225,6 +262,12 @@ declare interface MarkdownOptions {
      * @default true
      */
     crossCompilerCache?: boolean;
+    /**
+     * Whether to automatically extract a description from the markdown content,
+     * typically from the first paragraph, for use in page metadata or previews.
+     * @default true
+     */
+    extractDescription?: boolean;
 }
 
 export declare const mergeDocConfig: (...configs: UserConfig[]) => Promise<UserConfig>;
@@ -269,8 +312,8 @@ declare interface PageIndexInfo {
     title: string;
     toc: Header[];
     content: string;
+    description?: string;
     _flattenContent?: string;
-    _html: string;
     frontmatter: FrontMatterMeta;
     lang: string;
     version: string;
@@ -568,6 +611,12 @@ declare type ThemeConfig = {
      * @default true
      */
     fallbackHeadingTitle?: boolean;
+    /**
+     * LLMS UI components configuration.
+     * When llmsUI.enableOnH1 is true, LlmsCopyButton and LlmsViewOptions
+     * will be automatically added below H1 headers.
+     */
+    llmsUI?: LlmsUI;
 };
 
 declare interface UserConfig {
@@ -588,6 +637,11 @@ declare interface UserConfig {
      * @default ''
      */
     logoText?: string;
+    /**
+     * Custom link for the logo.
+     * @default '/${lang}/'
+     */
+    logoHref?: string;
     /**
      * Base path of the site.
      * @default '/'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "2.0.0-rc.5",
+  "version": "2.0.0-rc.7",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/web-infra-dev/rspress.git",
@@ -32,17 +32,17 @@
     "dist"
   ],
   "dependencies": {
-    "@rsbuild/core": "~1.7.1",
-    "@shikijs/rehype": "^3.20.0",
+    "@rsbuild/core": "2.0.0-alpha.2",
+    "@shikijs/rehype": "^3.21.0",
     "gray-matter": "4.0.3",
     "lodash-es": "^4.17.22",
     "unified": "^11.0.5"
   },
   "devDependencies": {
-    "@rslib/core": "0.19.1",
+    "@rslib/core": "0.19.2",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^22.8.1",
-    "@types/react": "^19.2.7",
+    "@types/react": "^19.2.8",
     "mdast-util-mdx-jsx": "^3.2.0",
     "medium-zoom": "1.1.0",
     "rimraf": "^6.1.2",