@docusaurus/types 3.8.1-canary-6373 → 3.8.1-canary-6375

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/package.json +2 -2
  2. package/src/i18n.d.ts +19 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@docusaurus/types",
3
- "version": "3.8.1-canary-6373",
3
+ "version": "3.8.1-canary-6375",
4
4
  "description": "Common types for Docusaurus packages.",
5
5
  "types": "./src/index.d.ts",
6
6
  "publishConfig": {
@@ -28,5 +28,5 @@
28
28
  "react": "^18.0.0 || ^19.0.0",
29
29
  "react-dom": "^18.0.0 || ^19.0.0"
30
30
  },
31
- "gitHead": "e7cd5f17e74b237f5b60934fa035f1bcd7361c6a"
31
+ "gitHead": "1892984e51e133ffb5cc066116eda647753dbfb2"
32
32
  }
package/src/i18n.d.ts CHANGED
@@ -37,6 +37,25 @@ export type I18nLocaleConfig = {
37
37
  * By default, it will only be run if the `./i18n/<locale>` exists.
38
38
  */
39
39
  translate: boolean;
40
+
41
+ /**
42
+ * For i18n sites deployed to distinct domains, it is recommended to configure
43
+ * a site url on a per-locale basis.
44
+ */
45
+ url: string;
46
+
47
+ /**
48
+ * An explicit baseUrl to use for this locale, overriding the default one:
49
+ * Default values:
50
+ * - Default locale: `/${siteConfig.baseUrl}/`
51
+ * - Other locales: `/${siteConfig.baseUrl}/<locale>/`
52
+ *
53
+ * Exception: when using the CLI with a single `--locale` parameter, the
54
+ * `/<locale>/` path segment is not included. This is a better default for
55
+ * sites looking to deploy each locale to a different subdomain, such as
56
+ * `https://<locale>.docusaurus.io`
57
+ */
58
+ baseUrl: string;
40
59
  };
41
60
 
42
61
  export type I18nConfig = {