@rspress/shared 1.0.0-beta.2 → 1.0.0-beta.4

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.
Files changed (2) hide show
  1. package/dist/index.d.ts +17 -8
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -57,7 +57,7 @@ interface Config$1 {
57
57
  /**
58
58
  * Custom outline title in the aside component.
59
59
  *
60
- * @default 'On this page'
60
+ * @default 'ON THIS PAGE'
61
61
  */
62
62
  outlineTitle?: string;
63
63
  /**
@@ -119,13 +119,9 @@ interface Config$1 {
119
119
  */
120
120
  search?: boolean;
121
121
  /**
122
- * Whether to use back top
122
+ * The behavior of hiding navbar
123
123
  */
124
- backTop?: boolean;
125
- /**
126
- * Whether to hide the navbar
127
- */
128
- hideNavbar?: boolean;
124
+ hideNavbar?: 'always' | 'auto' | 'never';
129
125
  /**
130
126
  * Whether to enable the animation for translation pages
131
127
  */
@@ -615,10 +611,23 @@ type SearchOptions = LocalSearchOptions | RemoteSearchOptions | false;
615
611
  interface MarkdownOptions {
616
612
  remarkPlugins?: PluggableList;
617
613
  rehypePlugins?: PluggableList;
614
+ /**
615
+ * Whether to enable check dead links, default is false
616
+ */
618
617
  checkDeadLinks?: boolean;
619
- experimentalMdxRs?: boolean;
620
618
  showLineNumbers?: boolean;
619
+ /**
620
+ * Register global components in mdx files
621
+ */
621
622
  globalComponents?: string[];
623
+ /**
624
+ * Whether to enable mdx-rs, default is true
625
+ */
626
+ mdxRs?: boolean;
627
+ /**
628
+ * @deprecated, use `mdxRs` instead
629
+ */
630
+ experimentalMdxRs?: boolean;
622
631
  }
623
632
  type Config = UserConfig | Promise<UserConfig> | ((env: any) => UserConfig | Promise<UserConfig>);
624
633
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rspress/shared",
3
- "version": "1.0.0-beta.2",
3
+ "version": "1.0.0-beta.4",
4
4
  "types": "./dist/index.d.ts",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",