@docusaurus/types 0.0.0-5945 → 0.0.0-5946

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/types",
-  "version": "0.0.0-5945",
+  "version": "0.0.0-5946",
   "description": "Common types for Docusaurus packages.",
   "types": "./src/index.d.ts",
   "publishConfig": {
@@ -27,5 +27,5 @@
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
-  "gitHead": "93d26c046a449a18fd39d96f34d08518f833cdf3"
+  "gitHead": "22332e32d47aea6bc27ca36b2ef50f12cd1427c8"
 }

package/src/config.d.ts

@@ -17,6 +17,8 @@ export type RemarkRehypeOptions = ProcessorOptions['remarkRehypeOptions'];
 
 export type ReportingSeverity = 'ignore' | 'log' | 'warn' | 'throw';
 
+export type RouterType = 'browser' | 'hash';
+
 export type ThemeConfig = {
   [key: string]: unknown;
 };
@@ -123,6 +125,24 @@ export type StorageConfig = {
 
 export type FutureConfig = {
   experimental_storage: StorageConfig;
+
+  /**
+   * Docusaurus can work with 2 router types.
+   *
+   * - The "browser" router is the main/default router of Docusaurus.
+   *   It will use the browser history and regular urls to navigate from
+   *   one page to another. A static file will be emitted for each page.
+   *
+   * - The "hash" router can be useful in very specific situations (such as
+   *   distributing your app for offline-first usage), but should be avoided
+   *   in most cases. All pages paths will be prefixed with a /#/.
+   *   It will opt out of static site generation, only emit a single index.html
+   *   entry point, and use the browser hash for routing. The Docusaurus site
+   *   content will be rendered client-side, like a regular single page
+   *   application.
+   *   @see https://github.com/facebook/docusaurus/issues/3825
+   */
+  experimental_router: RouterType;
 };
 
 /**

package/src/index.d.ts

@@ -7,6 +7,7 @@
 
 export {
   ReportingSeverity,
+  RouterType,
   ThemeConfig,
   MarkdownConfig,
   DefaultParseFrontMatter,