@docusaurus/theme-common 3.1.1 → 3.2.1
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/lib/index.d.ts +1 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +1 -0
- package/lib/index.js.map +1 -1
- package/lib/internal.d.ts +1 -0
- package/lib/internal.d.ts.map +1 -1
- package/lib/internal.js +1 -0
- package/lib/internal.js.map +1 -1
- package/lib/utils/IntlUtils.d.ts +3 -0
- package/lib/utils/IntlUtils.d.ts.map +1 -0
- package/lib/utils/IntlUtils.js +20 -0
- package/lib/utils/IntlUtils.js.map +1 -0
- package/lib/utils/ThemeClassNames.d.ts +4 -1
- package/lib/utils/ThemeClassNames.d.ts.map +1 -1
- package/lib/utils/ThemeClassNames.js +3 -1
- package/lib/utils/ThemeClassNames.js.map +1 -1
- package/lib/utils/structuredDataUtils.d.ts +12 -0
- package/lib/utils/structuredDataUtils.d.ts.map +1 -0
- package/lib/utils/structuredDataUtils.js +123 -0
- package/lib/utils/structuredDataUtils.js.map +1 -0
- package/package.json +13 -12
- package/src/index.ts +5 -0
- package/src/internal.ts +1 -0
- package/src/utils/IntlUtils.ts +27 -0
- package/src/utils/ThemeClassNames.ts +2 -0
- package/src/utils/structuredDataUtils.ts +177 -0
package/lib/index.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ export { default as ThemedComponent } from './components/ThemedComponent';
|
|
|
9
9
|
export { createStorageSlot, useStorageSlot, listStorageKeys, } from './utils/storageUtils';
|
|
10
10
|
export { useContextualSearchFilters } from './utils/searchUtils';
|
|
11
11
|
export { useCurrentSidebarCategory, filterDocCardListItems, } from './utils/docsUtils';
|
|
12
|
+
export { useBlogListPageStructuredData, useBlogPostStructuredData, } from './utils/structuredDataUtils';
|
|
12
13
|
export { usePluralForm } from './utils/usePluralForm';
|
|
13
14
|
export { useCollapsible, Collapsible } from './components/Collapsible';
|
|
14
15
|
export { ThemeClassNames } from './utils/ThemeClassNames';
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,EACL,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EACL,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAE,KAAK,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAOpD,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,KAAK,cAAc,GACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,uBAAuB,EAAC,MAAM,iCAAiC,CAAC;AAExE,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,kBAAkB,GACnB,MAAM,4BAA4B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,EACL,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EACL,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,6BAA6B,EAC7B,yBAAyB,GAC1B,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAE,KAAK,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAOpD,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,KAAK,cAAc,GACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,uBAAuB,EAAC,MAAM,iCAAiC,CAAC;AAExE,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,kBAAkB,GACnB,MAAM,4BAA4B,CAAC"}
|
package/lib/index.js
CHANGED
|
@@ -12,6 +12,7 @@ export { default as ThemedComponent } from './components/ThemedComponent';
|
|
|
12
12
|
export { createStorageSlot, useStorageSlot, listStorageKeys, } from './utils/storageUtils';
|
|
13
13
|
export { useContextualSearchFilters } from './utils/searchUtils';
|
|
14
14
|
export { useCurrentSidebarCategory, filterDocCardListItems, } from './utils/docsUtils';
|
|
15
|
+
export { useBlogListPageStructuredData, useBlogPostStructuredData, } from './utils/structuredDataUtils';
|
|
15
16
|
export { usePluralForm } from './utils/usePluralForm';
|
|
16
17
|
export { useCollapsible, Collapsible } from './components/Collapsible';
|
|
17
18
|
export { ThemeClassNames } from './utils/ThemeClassNames';
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AAEH,OAAO,EACL,cAAc,GAYf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EACL,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAiB,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,GAE1B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD;;;GAGG;AAEH,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAElB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,uBAAuB,EAAC,MAAM,iCAAiC,CAAC;AAExE,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,kBAAkB,GACnB,MAAM,4BAA4B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AAEH,OAAO,EACL,cAAc,GAYf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EACL,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,6BAA6B,EAC7B,yBAAyB,GAC1B,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAiB,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,GAE1B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD;;;GAGG;AAEH,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAElB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,uBAAuB,EAAC,MAAM,iCAAiC,CAAC;AAExE,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,kBAAkB,GACnB,MAAM,4BAA4B,CAAC"}
|
package/lib/internal.d.ts
CHANGED
|
@@ -32,6 +32,7 @@ export { PluginHtmlClassNameProvider } from './utils/metadataUtils';
|
|
|
32
32
|
export { splitNavbarItems, NavbarProvider } from './utils/navbarUtils';
|
|
33
33
|
export { useTOCHighlight, type TOCHighlightConfig, } from './hooks/useTOCHighlight';
|
|
34
34
|
export { useVisibleBlogSidebarItems } from './utils/blogUtils';
|
|
35
|
+
export { useDateTimeFormat } from './utils/IntlUtils';
|
|
35
36
|
export { useHideableNavbar } from './hooks/useHideableNavbar';
|
|
36
37
|
export { useKeyboardNavigation, keyboardFocusedClassName, } from './hooks/useKeyboardNavigation';
|
|
37
38
|
export { useLockBodyScroll } from './hooks/useLockBodyScroll';
|
package/lib/internal.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,cAAc,SAAS,CAAC;AAExB,OAAO,EACL,oCAAoC,EACpC,+BAA+B,GAChC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAE3E,OAAO,EAAC,WAAW,EAAE,MAAM,EAAE,KAAK,eAAe,EAAC,MAAM,gBAAgB,CAAC;AACzE,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,KAAK,oBAAoB,GAC1B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,iCAAiC,EACjC,mCAAmC,GACpC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAC,MAAM,mBAAmB,CAAC;AAChE,YAAY,EAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAEzE,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAC,sBAAsB,EAAC,MAAM,wCAAwC,CAAC;AAE9E,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,qBAAqB,EAAC,MAAM,+BAA+B,CAAC;AAEpE,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,mBAAmB,GACpB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EACL,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,wBAAwB,EACxB,YAAY,EACZ,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,0BAA0B,EAC1B,eAAe,EACf,KAAK,WAAW,GACjB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAC,gBAAgB,EAAE,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAEjE,OAAO,EAAC,2BAA2B,EAAC,MAAM,uBAAuB,CAAC;AAElE,OAAO,EAAC,gBAAgB,EAAE,cAAc,EAAC,MAAM,qBAAqB,CAAC;AAErE,OAAO,EACL,eAAe,EACf,KAAK,kBAAkB,GACxB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAC,0BAA0B,EAAC,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,cAAc,SAAS,CAAC;AAExB,OAAO,EACL,oCAAoC,EACpC,+BAA+B,GAChC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAE3E,OAAO,EAAC,WAAW,EAAE,MAAM,EAAE,KAAK,eAAe,EAAC,MAAM,gBAAgB,CAAC;AACzE,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,KAAK,oBAAoB,GAC1B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,iCAAiC,EACjC,mCAAmC,GACpC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAC,MAAM,mBAAmB,CAAC;AAChE,YAAY,EAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAEzE,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAC,sBAAsB,EAAC,MAAM,wCAAwC,CAAC;AAE9E,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,qBAAqB,EAAC,MAAM,+BAA+B,CAAC;AAEpE,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,mBAAmB,GACpB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EACL,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,wBAAwB,EACxB,YAAY,EACZ,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,0BAA0B,EAC1B,eAAe,EACf,KAAK,WAAW,GACjB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAC,gBAAgB,EAAE,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAEjE,OAAO,EAAC,2BAA2B,EAAC,MAAM,uBAAuB,CAAC;AAElE,OAAO,EAAC,gBAAgB,EAAE,cAAc,EAAC,MAAM,qBAAqB,CAAC;AAErE,OAAO,EACL,eAAe,EACf,KAAK,kBAAkB,GACxB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAC,0BAA0B,EAAC,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EACL,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAC,oBAAoB,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAC,kBAAkB,EAAC,MAAM,4BAA4B,CAAC"}
|
package/lib/internal.js
CHANGED
|
@@ -42,6 +42,7 @@ export { PluginHtmlClassNameProvider } from './utils/metadataUtils';
|
|
|
42
42
|
export { splitNavbarItems, NavbarProvider } from './utils/navbarUtils';
|
|
43
43
|
export { useTOCHighlight, } from './hooks/useTOCHighlight';
|
|
44
44
|
export { useVisibleBlogSidebarItems } from './utils/blogUtils';
|
|
45
|
+
export { useDateTimeFormat } from './utils/IntlUtils';
|
|
45
46
|
export { useHideableNavbar } from './hooks/useHideableNavbar';
|
|
46
47
|
export { useKeyboardNavigation, keyboardFocusedClassName, } from './hooks/useKeyboardNavigation';
|
|
47
48
|
export { useLockBodyScroll } from './hooks/useLockBodyScroll';
|
package/lib/internal.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,4EAA4E;AAC5E,6EAA6E;AAC7E,2EAA2E;AAC3E,uDAAuD;AACvD,EAAE;AACF,6DAA6D;AAC7D,gFAAgF;AAChF,yEAAyE;AACzE,oDAAoD;AACpD,EAAE;AACF,gDAAgD;AAChD,cAAc,SAAS,CAAC;AAExB,OAAO,EACL,oCAAoC,EACpC,+BAA+B,GAChC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAE3E,OAAO,EAAC,WAAW,EAAE,MAAM,EAAuB,MAAM,gBAAgB,CAAC;AACzE,OAAO,EACL,gBAAgB,EAChB,WAAW,GAEZ,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,iCAAiC,EACjC,mCAAmC,GACpC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAC,MAAM,mBAAmB,CAAC;AAGhE,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAC,sBAAsB,EAAC,MAAM,wCAAwC,CAAC;AAE9E,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,qBAAqB,EAAC,MAAM,+BAA+B,CAAC;AAEpE,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,mBAAmB,GACpB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EACL,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,wBAAwB,EACxB,YAAY,EACZ,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,0BAA0B,EAC1B,eAAe,GAEhB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAC,gBAAgB,EAAE,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAEjE,OAAO,EAAC,2BAA2B,EAAC,MAAM,uBAAuB,CAAC;AAElE,OAAO,EAAC,gBAAgB,EAAE,cAAc,EAAC,MAAM,qBAAqB,CAAC;AAErE,OAAO,EACL,eAAe,GAEhB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAC,0BAA0B,EAAC,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,4EAA4E;AAC5E,6EAA6E;AAC7E,2EAA2E;AAC3E,uDAAuD;AACvD,EAAE;AACF,6DAA6D;AAC7D,gFAAgF;AAChF,yEAAyE;AACzE,oDAAoD;AACpD,EAAE;AACF,gDAAgD;AAChD,cAAc,SAAS,CAAC;AAExB,OAAO,EACL,oCAAoC,EACpC,+BAA+B,GAChC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAE3E,OAAO,EAAC,WAAW,EAAE,MAAM,EAAuB,MAAM,gBAAgB,CAAC;AACzE,OAAO,EACL,gBAAgB,EAChB,WAAW,GAEZ,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,iCAAiC,EACjC,mCAAmC,GACpC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAC,MAAM,mBAAmB,CAAC;AAGhE,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAC,sBAAsB,EAAC,MAAM,wCAAwC,CAAC;AAE9E,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,qBAAqB,EAAC,MAAM,+BAA+B,CAAC;AAEpE,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,mBAAmB,GACpB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EACL,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,wBAAwB,EACxB,YAAY,EACZ,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,0BAA0B,EAC1B,eAAe,GAEhB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAC,gBAAgB,EAAE,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAEjE,OAAO,EAAC,2BAA2B,EAAC,MAAM,uBAAuB,CAAC;AAElE,OAAO,EAAC,gBAAgB,EAAE,cAAc,EAAC,MAAM,qBAAqB,CAAC;AAErE,OAAO,EACL,eAAe,GAEhB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAC,0BAA0B,EAAC,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EACL,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAC,oBAAoB,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAC,kBAAkB,EAAC,MAAM,4BAA4B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IntlUtils.d.ts","sourceRoot":"","sources":["../../src/utils/IntlUtils.ts"],"names":[],"mappings":"AAQA,wBAAgB,WAAW,IAAI,MAAM,CAKpC;AAED,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,IAAI,CAAC,qBAA0B,GACvC,IAAI,CAAC,cAAc,CASrB"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
|
8
|
+
export function useCalendar() {
|
|
9
|
+
const { i18n: { currentLocale, localeConfigs }, } = useDocusaurusContext();
|
|
10
|
+
return localeConfigs[currentLocale].calendar;
|
|
11
|
+
}
|
|
12
|
+
export function useDateTimeFormat(options = {}) {
|
|
13
|
+
const { i18n: { currentLocale }, } = useDocusaurusContext();
|
|
14
|
+
const calendar = useCalendar();
|
|
15
|
+
return new Intl.DateTimeFormat(currentLocale, {
|
|
16
|
+
calendar,
|
|
17
|
+
...options,
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=IntlUtils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IntlUtils.js","sourceRoot":"","sources":["../../src/utils/IntlUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAEpE,MAAM,UAAU,WAAW;IACzB,MAAM,EACJ,IAAI,EAAE,EAAC,aAAa,EAAE,aAAa,EAAC,GACrC,GAAG,oBAAoB,EAAE,CAAC;IAC3B,OAAO,aAAa,CAAC,aAAa,CAAE,CAAC,QAAQ,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,UAAsC,EAAE;IAExC,MAAM,EACJ,IAAI,EAAE,EAAC,aAAa,EAAC,GACtB,GAAG,oBAAoB,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE;QAC5C,QAAQ;QACR,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -55,6 +55,9 @@ export declare const ThemeClassNames: {
|
|
|
55
55
|
readonly docSidebarItemCategoryLevel: (level: number) => `theme-doc-sidebar-item-category-level-${number}`;
|
|
56
56
|
readonly docSidebarItemLinkLevel: (level: number) => `theme-doc-sidebar-item-link-level-${number}`;
|
|
57
57
|
};
|
|
58
|
-
readonly blog: {
|
|
58
|
+
readonly blog: {
|
|
59
|
+
readonly blogFooterTagsRow: "theme-blog-footer-tags-row";
|
|
60
|
+
readonly blogFooterEditMetaRow: "theme-blog-footer-edit-meta-row";
|
|
61
|
+
};
|
|
59
62
|
};
|
|
60
63
|
//# sourceMappingURL=ThemeClassNames.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ThemeClassNames.d.ts","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;wCA8BD,MAAM;;;IAM/B;;OAEG;;;;;;;;;;;;;;;sDAeoC,MAAM;kDAEV,MAAM
|
|
1
|
+
{"version":3,"file":"ThemeClassNames.d.ts","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;wCA8BD,MAAM;;;IAM/B;;OAEG;;;;;;;;;;;;;;;sDAeoC,MAAM;kDAEV,MAAM;;;;;;CASjC,CAAC"}
|
|
@@ -64,7 +64,9 @@ export const ThemeClassNames = {
|
|
|
64
64
|
// TODO add other stable classNames here
|
|
65
65
|
},
|
|
66
66
|
blog: {
|
|
67
|
-
|
|
67
|
+
// TODO add other stable classNames here
|
|
68
|
+
blogFooterTagsRow: 'theme-blog-footer-tags-row',
|
|
69
|
+
blogFooterEditMetaRow: 'theme-blog-footer-edit-meta-row',
|
|
68
70
|
},
|
|
69
71
|
};
|
|
70
72
|
//# sourceMappingURL=ThemeClassNames.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ThemeClassNames.js","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,+EAA+E;AAC/E,aAAa;AAEb;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE;QACJ,YAAY,EAAE,gBAAgB;QAC9B,YAAY,EAAE,gBAAgB;QAC9B,gBAAgB,EAAE,qBAAqB;QACvC,mBAAmB,EAAE,0BAA0B;QAE/C,WAAW,EAAE,eAAe;QAC5B,gBAAgB,EAAE,qBAAqB;QACvC,kBAAkB,EAAE,yBAAyB;QAE7C,OAAO,EAAE,UAAU;KACpB;IACD,OAAO,EAAE;QACP,IAAI,EAAE,cAAc;QACpB,uDAAuD;QACvD,uCAAuC;QACvC,+DAA+D;QAC/D,SAAS,EAAE,cAAc;QACzB,SAAS,EAAE,cAAc;QACzB,QAAQ,EAAE,aAAa;KACxB;IACD,MAAM,EAAE;QACN,YAAY,EAAE,sBAAsB;QACpC,WAAW,EAAE,oBAAoB;QACjC,eAAe,EAAE,0BAA0B;QAC3C,SAAS,EAAE,kBAAkB;QAC7B,UAAU,EAAE,kBAAkB;QAC9B,cAAc,EAAE,uBAAuB;QAEvC,cAAc,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,oBAAoB,IAAI,EAAE;KAC7D;IACD,MAAM,EAAE;IACN,wCAAwC;KACzC;IAED;;OAEG;IACH,IAAI,EAAE;QACJ,gBAAgB,EAAE,0BAA0B;QAC5C,eAAe,EAAE,yBAAyB;QAC1C,cAAc,EAAE,uBAAuB;QACvC,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,sBAAsB;QACpC,aAAa,EAAE,uBAAuB;QACtC,SAAS,EAAE,kBAAkB;QAC7B,gBAAgB,EAAE,2BAA2B;QAC7C,oBAAoB,EAAE,gCAAgC;QACtD,mBAAmB,EAAE,6BAA6B;QAClD,cAAc,EAAE,wBAAwB;QACxC,sBAAsB,EAAE,iCAAiC;QACzD,kBAAkB,EAAE,6BAA6B;QACjD,2BAA2B,EAAE,CAAC,KAAa,EAAE,EAAE,CAC7C,yCAAyC,KAAK,EAAW;QAC3D,uBAAuB,EAAE,CAAC,KAAa,EAAE,EAAE,CACzC,qCAAqC,KAAK,EAAW;QACvD,wCAAwC;KACzC;IACD,IAAI,EAAE;
|
|
1
|
+
{"version":3,"file":"ThemeClassNames.js","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,+EAA+E;AAC/E,aAAa;AAEb;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE;QACJ,YAAY,EAAE,gBAAgB;QAC9B,YAAY,EAAE,gBAAgB;QAC9B,gBAAgB,EAAE,qBAAqB;QACvC,mBAAmB,EAAE,0BAA0B;QAE/C,WAAW,EAAE,eAAe;QAC5B,gBAAgB,EAAE,qBAAqB;QACvC,kBAAkB,EAAE,yBAAyB;QAE7C,OAAO,EAAE,UAAU;KACpB;IACD,OAAO,EAAE;QACP,IAAI,EAAE,cAAc;QACpB,uDAAuD;QACvD,uCAAuC;QACvC,+DAA+D;QAC/D,SAAS,EAAE,cAAc;QACzB,SAAS,EAAE,cAAc;QACzB,QAAQ,EAAE,aAAa;KACxB;IACD,MAAM,EAAE;QACN,YAAY,EAAE,sBAAsB;QACpC,WAAW,EAAE,oBAAoB;QACjC,eAAe,EAAE,0BAA0B;QAC3C,SAAS,EAAE,kBAAkB;QAC7B,UAAU,EAAE,kBAAkB;QAC9B,cAAc,EAAE,uBAAuB;QAEvC,cAAc,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,oBAAoB,IAAI,EAAE;KAC7D;IACD,MAAM,EAAE;IACN,wCAAwC;KACzC;IAED;;OAEG;IACH,IAAI,EAAE;QACJ,gBAAgB,EAAE,0BAA0B;QAC5C,eAAe,EAAE,yBAAyB;QAC1C,cAAc,EAAE,uBAAuB;QACvC,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,sBAAsB;QACpC,aAAa,EAAE,uBAAuB;QACtC,SAAS,EAAE,kBAAkB;QAC7B,gBAAgB,EAAE,2BAA2B;QAC7C,oBAAoB,EAAE,gCAAgC;QACtD,mBAAmB,EAAE,6BAA6B;QAClD,cAAc,EAAE,wBAAwB;QACxC,sBAAsB,EAAE,iCAAiC;QACzD,kBAAkB,EAAE,6BAA6B;QACjD,2BAA2B,EAAE,CAAC,KAAa,EAAE,EAAE,CAC7C,yCAAyC,KAAK,EAAW;QAC3D,uBAAuB,EAAE,CAAC,KAAa,EAAE,EAAE,CACzC,qCAAqC,KAAK,EAAW;QACvD,wCAAwC;KACzC;IACD,IAAI,EAAE;QACJ,wCAAwC;QACxC,iBAAiB,EAAE,4BAA4B;QAC/C,qBAAqB,EAAE,iCAAiC;KACzD;CACO,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
/// <reference types="@docusaurus/plugin-content-blog" />
|
|
8
|
+
import type { Props as BlogListPageStructuredDataProps } from '@theme/BlogListPage/StructuredData';
|
|
9
|
+
import type { Blog, BlogPosting, WithContext } from 'schema-dts';
|
|
10
|
+
export declare function useBlogListPageStructuredData(props: BlogListPageStructuredDataProps): WithContext<Blog>;
|
|
11
|
+
export declare function useBlogPostStructuredData(): WithContext<BlogPosting>;
|
|
12
|
+
//# sourceMappingURL=structuredDataUtils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"structuredDataUtils.d.ts","sourceRoot":"","sources":["../../src/utils/structuredDataUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;;AAKH,OAAO,KAAK,EAAC,KAAK,IAAI,+BAA+B,EAAC,MAAM,oCAAoC,CAAC;AAEjG,OAAO,KAAK,EACV,IAAI,EACJ,WAAW,EACX,WAAW,EAGZ,MAAM,YAAY,CAAC;AAiEpB,wBAAgB,6BAA6B,CAC3C,KAAK,EAAE,+BAA+B,GACrC,WAAW,CAAC,IAAI,CAAC,CAsBnB;AAED,wBAAgB,yBAAyB,IAAI,WAAW,CAAC,WAAW,CAAC,CAsCpE"}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import { useBaseUrlUtils } from '@docusaurus/useBaseUrl';
|
|
8
|
+
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
|
9
|
+
import { useBlogMetadata } from '@docusaurus/plugin-content-blog/client';
|
|
10
|
+
import { useBlogPost } from '../contexts/blogPost';
|
|
11
|
+
const convertDate = (dateMs) => new Date(dateMs).toISOString();
|
|
12
|
+
function getBlogPost(blogPostContent, siteConfig, withBaseUrl) {
|
|
13
|
+
const { assets, frontMatter, metadata } = blogPostContent;
|
|
14
|
+
const { date, title, description, lastUpdatedAt } = metadata;
|
|
15
|
+
const image = assets.image ?? frontMatter.image;
|
|
16
|
+
const keywords = frontMatter.keywords ?? [];
|
|
17
|
+
const blogUrl = `${siteConfig.url}${metadata.permalink}`;
|
|
18
|
+
const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
|
|
19
|
+
return {
|
|
20
|
+
'@type': 'BlogPosting',
|
|
21
|
+
'@id': blogUrl,
|
|
22
|
+
mainEntityOfPage: blogUrl,
|
|
23
|
+
url: blogUrl,
|
|
24
|
+
headline: title,
|
|
25
|
+
name: title,
|
|
26
|
+
description,
|
|
27
|
+
datePublished: date,
|
|
28
|
+
...(dateModified ? { dateModified } : {}),
|
|
29
|
+
...getAuthor(metadata.authors),
|
|
30
|
+
...getImage(image, withBaseUrl, title),
|
|
31
|
+
...(keywords ? { keywords } : {}),
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
function getAuthor(authors) {
|
|
35
|
+
const authorsStructuredData = authors.map(createPersonStructuredData);
|
|
36
|
+
return {
|
|
37
|
+
author: authorsStructuredData.length === 1
|
|
38
|
+
? authorsStructuredData[0]
|
|
39
|
+
: authorsStructuredData,
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
function getImage(image, withBaseUrl, title) {
|
|
43
|
+
return image
|
|
44
|
+
? {
|
|
45
|
+
image: createImageStructuredData({
|
|
46
|
+
imageUrl: withBaseUrl(image, { absolute: true }),
|
|
47
|
+
caption: `title image for the blog post: ${title}`,
|
|
48
|
+
}),
|
|
49
|
+
}
|
|
50
|
+
: {};
|
|
51
|
+
}
|
|
52
|
+
export function useBlogListPageStructuredData(props) {
|
|
53
|
+
const { siteConfig } = useDocusaurusContext();
|
|
54
|
+
const { withBaseUrl } = useBaseUrlUtils();
|
|
55
|
+
const { metadata: { blogDescription, blogTitle, permalink }, } = props;
|
|
56
|
+
const url = `${siteConfig.url}${permalink}`;
|
|
57
|
+
// details on structured data support: https://schema.org/Blog
|
|
58
|
+
return {
|
|
59
|
+
'@context': 'https://schema.org',
|
|
60
|
+
'@type': 'Blog',
|
|
61
|
+
'@id': url,
|
|
62
|
+
mainEntityOfPage: url,
|
|
63
|
+
headline: blogTitle,
|
|
64
|
+
description: blogDescription,
|
|
65
|
+
blogPost: props.items.map((blogItem) => getBlogPost(blogItem.content, siteConfig, withBaseUrl)),
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
export function useBlogPostStructuredData() {
|
|
69
|
+
const blogMetadata = useBlogMetadata();
|
|
70
|
+
const { assets, metadata } = useBlogPost();
|
|
71
|
+
const { siteConfig } = useDocusaurusContext();
|
|
72
|
+
const { withBaseUrl } = useBaseUrlUtils();
|
|
73
|
+
const { date, title, description, frontMatter, lastUpdatedAt } = metadata;
|
|
74
|
+
const image = assets.image ?? frontMatter.image;
|
|
75
|
+
const keywords = frontMatter.keywords ?? [];
|
|
76
|
+
const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
|
|
77
|
+
const url = `${siteConfig.url}${metadata.permalink}`;
|
|
78
|
+
// details on structured data support: https://schema.org/BlogPosting
|
|
79
|
+
// BlogPosting is one of the structured data types that Google explicitly
|
|
80
|
+
// supports: https://developers.google.com/search/docs/appearance/structured-data/article#structured-data-type-definitions
|
|
81
|
+
return {
|
|
82
|
+
'@context': 'https://schema.org',
|
|
83
|
+
'@type': 'BlogPosting',
|
|
84
|
+
'@id': url,
|
|
85
|
+
mainEntityOfPage: url,
|
|
86
|
+
url,
|
|
87
|
+
headline: title,
|
|
88
|
+
name: title,
|
|
89
|
+
description,
|
|
90
|
+
datePublished: date,
|
|
91
|
+
...(dateModified ? { dateModified } : {}),
|
|
92
|
+
...getAuthor(metadata.authors),
|
|
93
|
+
...getImage(image, withBaseUrl, title),
|
|
94
|
+
...(keywords ? { keywords } : {}),
|
|
95
|
+
isPartOf: {
|
|
96
|
+
'@type': 'Blog',
|
|
97
|
+
'@id': `${siteConfig.url}${blogMetadata.blogBasePath}`,
|
|
98
|
+
name: blogMetadata.blogTitle,
|
|
99
|
+
},
|
|
100
|
+
};
|
|
101
|
+
}
|
|
102
|
+
/** @returns A {@link https://schema.org/Person} constructed from the {@link Author} */
|
|
103
|
+
function createPersonStructuredData(author) {
|
|
104
|
+
return {
|
|
105
|
+
'@type': 'Person',
|
|
106
|
+
...(author.name ? { name: author.name } : {}),
|
|
107
|
+
...(author.title ? { description: author.title } : {}),
|
|
108
|
+
...(author.url ? { url: author.url } : {}),
|
|
109
|
+
...(author.email ? { email: author.email } : {}),
|
|
110
|
+
...(author.imageURL ? { image: author.imageURL } : {}),
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
/** @returns A {@link https://schema.org/ImageObject} */
|
|
114
|
+
function createImageStructuredData({ imageUrl, caption, }) {
|
|
115
|
+
return {
|
|
116
|
+
'@type': 'ImageObject',
|
|
117
|
+
'@id': imageUrl,
|
|
118
|
+
url: imageUrl,
|
|
119
|
+
contentUrl: imageUrl,
|
|
120
|
+
caption,
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
//# sourceMappingURL=structuredDataUtils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"structuredDataUtils.js","sourceRoot":"","sources":["../../src/utils/structuredDataUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,eAAe,EAAoB,MAAM,wBAAwB,CAAC;AAC1E,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAC,eAAe,EAAC,MAAM,wCAAwC,CAAC;AAEvE,OAAO,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AAcjD,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;AAEvE,SAAS,WAAW,CAClB,eAAoC,EACpC,UAA4B,EAC5B,WAAwC;IAExC,MAAM,EAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAC,GAAG,eAAe,CAAC;IACxD,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,aAAa,EAAC,GAAG,QAAQ,CAAC;IAE3D,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,CAAC;IAChD,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,IAAI,EAAE,CAAC;IAE5C,MAAM,OAAO,GAAG,GAAG,UAAU,CAAC,GAAG,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;IAEzD,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE5E,OAAO;QACL,OAAO,EAAE,aAAa;QACtB,KAAK,EAAE,OAAO;QACd,gBAAgB,EAAE,OAAO;QACzB,GAAG,EAAE,OAAO;QACZ,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,KAAK;QACX,WAAW;QACX,aAAa,EAAE,IAAI;QACnB,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAC,YAAY,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC9B,GAAG,QAAQ,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC;QACtC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAC,QAAQ,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KAChC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,OAAiB;IAClC,MAAM,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IACtE,OAAO;QACL,MAAM,EACJ,qBAAqB,CAAC,MAAM,KAAK,CAAC;YAChC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC;YAC1B,CAAC,CAAC,qBAAqB;KAC5B,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CACf,KAAyB,EACzB,WAAwC,EACxC,KAAa;IAEb,OAAO,KAAK;QACV,CAAC,CAAC;YACE,KAAK,EAAE,yBAAyB,CAAC;gBAC/B,QAAQ,EAAE,WAAW,CAAC,KAAK,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC;gBAC9C,OAAO,EAAE,kCAAkC,KAAK,EAAE;aACnD,CAAC;SACH;QACH,CAAC,CAAC,EAAE,CAAC;AACT,CAAC;AAED,MAAM,UAAU,6BAA6B,CAC3C,KAAsC;IAEtC,MAAM,EAAC,UAAU,EAAC,GAAG,oBAAoB,EAAE,CAAC;IAC5C,MAAM,EAAC,WAAW,EAAC,GAAG,eAAe,EAAE,CAAC;IAExC,MAAM,EACJ,QAAQ,EAAE,EAAC,eAAe,EAAE,SAAS,EAAE,SAAS,EAAC,GAClD,GAAG,KAAK,CAAC;IAEV,MAAM,GAAG,GAAG,GAAG,UAAU,CAAC,GAAG,GAAG,SAAS,EAAE,CAAC;IAE5C,8DAA8D;IAC9D,OAAO;QACL,UAAU,EAAE,oBAAoB;QAChC,OAAO,EAAE,MAAM;QACf,KAAK,EAAE,GAAG;QACV,gBAAgB,EAAE,GAAG;QACrB,QAAQ,EAAE,SAAS;QACnB,WAAW,EAAE,eAAe;QAC5B,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACrC,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,CAAC,CACvD;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB;IACvC,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,MAAM,EAAC,MAAM,EAAE,QAAQ,EAAC,GAAG,WAAW,EAAE,CAAC;IACzC,MAAM,EAAC,UAAU,EAAC,GAAG,oBAAoB,EAAE,CAAC;IAC5C,MAAM,EAAC,WAAW,EAAC,GAAG,eAAe,EAAE,CAAC;IAExC,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAC,GAAG,QAAQ,CAAC;IAExE,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,CAAC;IAChD,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,IAAI,EAAE,CAAC;IAE5C,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE5E,MAAM,GAAG,GAAG,GAAG,UAAU,CAAC,GAAG,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;IAErD,qEAAqE;IACrE,yEAAyE;IACzE,0HAA0H;IAC1H,OAAO;QACL,UAAU,EAAE,oBAAoB;QAChC,OAAO,EAAE,aAAa;QACtB,KAAK,EAAE,GAAG;QACV,gBAAgB,EAAE,GAAG;QACrB,GAAG;QACH,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,KAAK;QACX,WAAW;QACX,aAAa,EAAE,IAAI;QACnB,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAC,YAAY,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC9B,GAAG,QAAQ,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC;QACtC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAC,QAAQ,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/B,QAAQ,EAAE;YACR,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,GAAG,UAAU,CAAC,GAAG,GAAG,YAAY,CAAC,YAAY,EAAE;YACtD,IAAI,EAAE,YAAY,CAAC,SAAS;SAC7B;KACF,CAAC;AACJ,CAAC;AAED,uFAAuF;AACvF,SAAS,0BAA0B,CAAC,MAAc;IAChD,OAAO;QACL,OAAO,EAAE,QAAQ;QACjB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3C,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAC,WAAW,EAAE,MAAM,CAAC,KAAK,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACpD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACrD,CAAC;AACJ,CAAC;AAED,wDAAwD;AACxD,SAAS,yBAAyB,CAAC,EACjC,QAAQ,EACR,OAAO,GAIR;IACC,OAAO;QACL,OAAO,EAAE,aAAa;QACtB,KAAK,EAAE,QAAQ;QACf,GAAG,EAAE,QAAQ;QACb,UAAU,EAAE,QAAQ;QACpB,OAAO;KACR,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/theme-common",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.2.1",
|
|
4
4
|
"description": "Common code for Docusaurus themes.",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|
|
@@ -30,13 +30,13 @@
|
|
|
30
30
|
},
|
|
31
31
|
"license": "MIT",
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@docusaurus/mdx-loader": "3.
|
|
34
|
-
"@docusaurus/module-type-aliases": "3.
|
|
35
|
-
"@docusaurus/plugin-content-blog": "3.
|
|
36
|
-
"@docusaurus/plugin-content-docs": "3.
|
|
37
|
-
"@docusaurus/plugin-content-pages": "3.
|
|
38
|
-
"@docusaurus/utils": "3.
|
|
39
|
-
"@docusaurus/utils-common": "3.
|
|
33
|
+
"@docusaurus/mdx-loader": "3.2.1",
|
|
34
|
+
"@docusaurus/module-type-aliases": "3.2.1",
|
|
35
|
+
"@docusaurus/plugin-content-blog": "3.2.1",
|
|
36
|
+
"@docusaurus/plugin-content-docs": "3.2.1",
|
|
37
|
+
"@docusaurus/plugin-content-pages": "3.2.1",
|
|
38
|
+
"@docusaurus/utils": "3.2.1",
|
|
39
|
+
"@docusaurus/utils-common": "3.2.1",
|
|
40
40
|
"@types/history": "^4.7.11",
|
|
41
41
|
"@types/react": "*",
|
|
42
42
|
"@types/react-router-config": "*",
|
|
@@ -47,10 +47,11 @@
|
|
|
47
47
|
"utility-types": "^3.10.0"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
|
-
"@docusaurus/core": "3.
|
|
51
|
-
"@docusaurus/types": "3.
|
|
50
|
+
"@docusaurus/core": "3.2.1",
|
|
51
|
+
"@docusaurus/types": "3.2.1",
|
|
52
52
|
"fs-extra": "^11.1.1",
|
|
53
|
-
"lodash": "^4.17.21"
|
|
53
|
+
"lodash": "^4.17.21",
|
|
54
|
+
"schema-dts": "^1.1.2"
|
|
54
55
|
},
|
|
55
56
|
"peerDependencies": {
|
|
56
57
|
"react": "^18.0.0",
|
|
@@ -59,5 +60,5 @@
|
|
|
59
60
|
"engines": {
|
|
60
61
|
"node": ">=18.0"
|
|
61
62
|
},
|
|
62
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "f268e15264e208e6faf26117258162e988b53773"
|
|
63
64
|
}
|
package/src/index.ts
CHANGED
|
@@ -39,6 +39,11 @@ export {
|
|
|
39
39
|
filterDocCardListItems,
|
|
40
40
|
} from './utils/docsUtils';
|
|
41
41
|
|
|
42
|
+
export {
|
|
43
|
+
useBlogListPageStructuredData,
|
|
44
|
+
useBlogPostStructuredData,
|
|
45
|
+
} from './utils/structuredDataUtils';
|
|
46
|
+
|
|
42
47
|
export {usePluralForm} from './utils/usePluralForm';
|
|
43
48
|
|
|
44
49
|
export {useCollapsible, Collapsible} from './components/Collapsible';
|
package/src/internal.ts
CHANGED
|
@@ -114,6 +114,7 @@ export {
|
|
|
114
114
|
} from './hooks/useTOCHighlight';
|
|
115
115
|
|
|
116
116
|
export {useVisibleBlogSidebarItems} from './utils/blogUtils';
|
|
117
|
+
export {useDateTimeFormat} from './utils/IntlUtils';
|
|
117
118
|
|
|
118
119
|
export {useHideableNavbar} from './hooks/useHideableNavbar';
|
|
119
120
|
export {
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
|
8
|
+
|
|
9
|
+
export function useCalendar(): string {
|
|
10
|
+
const {
|
|
11
|
+
i18n: {currentLocale, localeConfigs},
|
|
12
|
+
} = useDocusaurusContext();
|
|
13
|
+
return localeConfigs[currentLocale]!.calendar;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export function useDateTimeFormat(
|
|
17
|
+
options: Intl.DateTimeFormatOptions = {},
|
|
18
|
+
): Intl.DateTimeFormat {
|
|
19
|
+
const {
|
|
20
|
+
i18n: {currentLocale},
|
|
21
|
+
} = useDocusaurusContext();
|
|
22
|
+
const calendar = useCalendar();
|
|
23
|
+
return new Intl.DateTimeFormat(currentLocale, {
|
|
24
|
+
calendar,
|
|
25
|
+
...options,
|
|
26
|
+
});
|
|
27
|
+
}
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import {useBaseUrlUtils, type BaseUrlUtils} from '@docusaurus/useBaseUrl';
|
|
9
|
+
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
|
10
|
+
import {useBlogMetadata} from '@docusaurus/plugin-content-blog/client';
|
|
11
|
+
import type {Props as BlogListPageStructuredDataProps} from '@theme/BlogListPage/StructuredData';
|
|
12
|
+
import {useBlogPost} from '../contexts/blogPost';
|
|
13
|
+
import type {
|
|
14
|
+
Blog,
|
|
15
|
+
BlogPosting,
|
|
16
|
+
WithContext,
|
|
17
|
+
Person,
|
|
18
|
+
ImageObject,
|
|
19
|
+
} from 'schema-dts';
|
|
20
|
+
import type {
|
|
21
|
+
Author,
|
|
22
|
+
PropBlogPostContent,
|
|
23
|
+
} from '@docusaurus/plugin-content-blog';
|
|
24
|
+
import type {DocusaurusConfig} from '@docusaurus/types';
|
|
25
|
+
|
|
26
|
+
const convertDate = (dateMs: number) => new Date(dateMs).toISOString();
|
|
27
|
+
|
|
28
|
+
function getBlogPost(
|
|
29
|
+
blogPostContent: PropBlogPostContent,
|
|
30
|
+
siteConfig: DocusaurusConfig,
|
|
31
|
+
withBaseUrl: BaseUrlUtils['withBaseUrl'],
|
|
32
|
+
): BlogPosting {
|
|
33
|
+
const {assets, frontMatter, metadata} = blogPostContent;
|
|
34
|
+
const {date, title, description, lastUpdatedAt} = metadata;
|
|
35
|
+
|
|
36
|
+
const image = assets.image ?? frontMatter.image;
|
|
37
|
+
const keywords = frontMatter.keywords ?? [];
|
|
38
|
+
|
|
39
|
+
const blogUrl = `${siteConfig.url}${metadata.permalink}`;
|
|
40
|
+
|
|
41
|
+
const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
|
|
42
|
+
|
|
43
|
+
return {
|
|
44
|
+
'@type': 'BlogPosting',
|
|
45
|
+
'@id': blogUrl,
|
|
46
|
+
mainEntityOfPage: blogUrl,
|
|
47
|
+
url: blogUrl,
|
|
48
|
+
headline: title,
|
|
49
|
+
name: title,
|
|
50
|
+
description,
|
|
51
|
+
datePublished: date,
|
|
52
|
+
...(dateModified ? {dateModified} : {}),
|
|
53
|
+
...getAuthor(metadata.authors),
|
|
54
|
+
...getImage(image, withBaseUrl, title),
|
|
55
|
+
...(keywords ? {keywords} : {}),
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
function getAuthor(authors: Author[]) {
|
|
60
|
+
const authorsStructuredData = authors.map(createPersonStructuredData);
|
|
61
|
+
return {
|
|
62
|
+
author:
|
|
63
|
+
authorsStructuredData.length === 1
|
|
64
|
+
? authorsStructuredData[0]
|
|
65
|
+
: authorsStructuredData,
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
function getImage(
|
|
70
|
+
image: string | undefined,
|
|
71
|
+
withBaseUrl: BaseUrlUtils['withBaseUrl'],
|
|
72
|
+
title: string,
|
|
73
|
+
) {
|
|
74
|
+
return image
|
|
75
|
+
? {
|
|
76
|
+
image: createImageStructuredData({
|
|
77
|
+
imageUrl: withBaseUrl(image, {absolute: true}),
|
|
78
|
+
caption: `title image for the blog post: ${title}`,
|
|
79
|
+
}),
|
|
80
|
+
}
|
|
81
|
+
: {};
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export function useBlogListPageStructuredData(
|
|
85
|
+
props: BlogListPageStructuredDataProps,
|
|
86
|
+
): WithContext<Blog> {
|
|
87
|
+
const {siteConfig} = useDocusaurusContext();
|
|
88
|
+
const {withBaseUrl} = useBaseUrlUtils();
|
|
89
|
+
|
|
90
|
+
const {
|
|
91
|
+
metadata: {blogDescription, blogTitle, permalink},
|
|
92
|
+
} = props;
|
|
93
|
+
|
|
94
|
+
const url = `${siteConfig.url}${permalink}`;
|
|
95
|
+
|
|
96
|
+
// details on structured data support: https://schema.org/Blog
|
|
97
|
+
return {
|
|
98
|
+
'@context': 'https://schema.org',
|
|
99
|
+
'@type': 'Blog',
|
|
100
|
+
'@id': url,
|
|
101
|
+
mainEntityOfPage: url,
|
|
102
|
+
headline: blogTitle,
|
|
103
|
+
description: blogDescription,
|
|
104
|
+
blogPost: props.items.map((blogItem) =>
|
|
105
|
+
getBlogPost(blogItem.content, siteConfig, withBaseUrl),
|
|
106
|
+
),
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
export function useBlogPostStructuredData(): WithContext<BlogPosting> {
|
|
111
|
+
const blogMetadata = useBlogMetadata();
|
|
112
|
+
const {assets, metadata} = useBlogPost();
|
|
113
|
+
const {siteConfig} = useDocusaurusContext();
|
|
114
|
+
const {withBaseUrl} = useBaseUrlUtils();
|
|
115
|
+
|
|
116
|
+
const {date, title, description, frontMatter, lastUpdatedAt} = metadata;
|
|
117
|
+
|
|
118
|
+
const image = assets.image ?? frontMatter.image;
|
|
119
|
+
const keywords = frontMatter.keywords ?? [];
|
|
120
|
+
|
|
121
|
+
const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
|
|
122
|
+
|
|
123
|
+
const url = `${siteConfig.url}${metadata.permalink}`;
|
|
124
|
+
|
|
125
|
+
// details on structured data support: https://schema.org/BlogPosting
|
|
126
|
+
// BlogPosting is one of the structured data types that Google explicitly
|
|
127
|
+
// supports: https://developers.google.com/search/docs/appearance/structured-data/article#structured-data-type-definitions
|
|
128
|
+
return {
|
|
129
|
+
'@context': 'https://schema.org',
|
|
130
|
+
'@type': 'BlogPosting',
|
|
131
|
+
'@id': url,
|
|
132
|
+
mainEntityOfPage: url,
|
|
133
|
+
url,
|
|
134
|
+
headline: title,
|
|
135
|
+
name: title,
|
|
136
|
+
description,
|
|
137
|
+
datePublished: date,
|
|
138
|
+
...(dateModified ? {dateModified} : {}),
|
|
139
|
+
...getAuthor(metadata.authors),
|
|
140
|
+
...getImage(image, withBaseUrl, title),
|
|
141
|
+
...(keywords ? {keywords} : {}),
|
|
142
|
+
isPartOf: {
|
|
143
|
+
'@type': 'Blog',
|
|
144
|
+
'@id': `${siteConfig.url}${blogMetadata.blogBasePath}`,
|
|
145
|
+
name: blogMetadata.blogTitle,
|
|
146
|
+
},
|
|
147
|
+
};
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/** @returns A {@link https://schema.org/Person} constructed from the {@link Author} */
|
|
151
|
+
function createPersonStructuredData(author: Author): Person {
|
|
152
|
+
return {
|
|
153
|
+
'@type': 'Person',
|
|
154
|
+
...(author.name ? {name: author.name} : {}),
|
|
155
|
+
...(author.title ? {description: author.title} : {}),
|
|
156
|
+
...(author.url ? {url: author.url} : {}),
|
|
157
|
+
...(author.email ? {email: author.email} : {}),
|
|
158
|
+
...(author.imageURL ? {image: author.imageURL} : {}),
|
|
159
|
+
};
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/** @returns A {@link https://schema.org/ImageObject} */
|
|
163
|
+
function createImageStructuredData({
|
|
164
|
+
imageUrl,
|
|
165
|
+
caption,
|
|
166
|
+
}: {
|
|
167
|
+
imageUrl: string;
|
|
168
|
+
caption: string;
|
|
169
|
+
}): ImageObject {
|
|
170
|
+
return {
|
|
171
|
+
'@type': 'ImageObject',
|
|
172
|
+
'@id': imageUrl,
|
|
173
|
+
url: imageUrl,
|
|
174
|
+
contentUrl: imageUrl,
|
|
175
|
+
caption,
|
|
176
|
+
};
|
|
177
|
+
}
|