@docusaurus/theme-classic 2.0.0-beta.1 → 2.0.0-beta.10
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/README.md +1 -1
- package/lib/__tests__/validateThemeConfig.test.js +277 -3
- package/lib/admonitions.css +35 -0
- package/lib/deps.d.ts +13 -0
- package/lib/index.js +41 -16
- package/lib/prism-include-languages.js +9 -5
- package/lib/theme/AnnouncementBar/index.js +10 -16
- package/lib/theme/AnnouncementBar/styles.module.css +25 -30
- package/lib/theme/BackToTopButton/index.js +140 -0
- package/lib/theme/BackToTopButton/styles.module.css +42 -0
- package/lib/theme/BlogArchivePage/index.js +89 -0
- package/lib/theme/BlogLayout/index.js +51 -0
- package/lib/theme/BlogListPage/index.js +10 -21
- package/lib/theme/BlogPostAuthor/index.js +51 -0
- package/lib/theme/BlogPostAuthor/styles.module.css +12 -0
- package/lib/theme/BlogPostAuthors/index.js +47 -0
- package/lib/theme/BlogPostAuthors/styles.module.css +11 -0
- package/lib/theme/BlogPostItem/index.js +58 -67
- package/lib/theme/BlogPostPage/index.js +37 -24
- package/lib/theme/BlogSidebar/index.js +5 -7
- package/lib/theme/BlogSidebar/styles.module.css +2 -2
- package/lib/theme/BlogTagsListPage/index.js +8 -44
- package/lib/theme/BlogTagsPostsPage/index.js +24 -38
- package/lib/theme/CodeBlock/index.js +18 -138
- package/lib/theme/CodeBlock/styles.module.css +6 -9
- package/lib/theme/Details/index.js +30 -0
- package/lib/theme/Details/styles.module.css +13 -0
- package/lib/theme/DocCard/index.js +84 -0
- package/lib/theme/DocCard/styles.module.css +43 -0
- package/lib/theme/DocCardList/index.js +28 -0
- package/lib/theme/DocCategoryGeneratedIndexPage/index.js +57 -0
- package/lib/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
- package/lib/theme/DocItem/index.js +29 -46
- package/lib/theme/DocItem/styles.module.css +5 -9
- package/lib/theme/DocItemFooter/index.js +79 -0
- package/lib/theme/DocItemFooter/styles.module.css +18 -0
- package/lib/theme/DocPage/index.js +35 -52
- package/lib/theme/DocPage/styles.module.css +8 -23
- package/lib/theme/DocPaginator/index.js +6 -7
- package/lib/theme/DocSidebar/index.js +53 -235
- package/lib/theme/DocSidebar/styles.module.css +0 -18
- package/lib/theme/DocSidebarItem/index.js +209 -0
- package/lib/theme/DocSidebarItem/styles.module.css +19 -0
- package/lib/theme/DocTagDocListPage/index.js +89 -0
- package/lib/theme/DocTagsListPage/index.js +44 -0
- package/lib/theme/DocVersionBadge/index.js +34 -0
- package/lib/theme/{DocVersionSuggestions → DocVersionBanner}/index.js +39 -20
- package/lib/theme/EditThisPage/index.js +3 -1
- package/lib/theme/ErrorPageContent.js +43 -0
- package/lib/theme/Footer/index.js +16 -5
- package/lib/theme/Heading/index.js +17 -22
- package/lib/theme/Heading/styles.css +5 -6
- package/lib/theme/Heading/styles.module.css +9 -5
- package/lib/theme/IconArrow/index.js +2 -2
- package/lib/theme/IconClose/index.js +31 -0
- package/lib/theme/IconEdit/index.js +3 -3
- package/lib/theme/IconExternalLink/index.js +3 -3
- package/lib/theme/IconLanguage/index.js +3 -3
- package/lib/theme/IconMenu/index.js +3 -3
- package/lib/theme/LastUpdated/index.js +4 -2
- package/lib/theme/Layout/index.js +5 -1
- package/lib/theme/LayoutHead/index.js +22 -17
- package/lib/theme/LayoutProviders/index.js +11 -5
- package/lib/theme/Logo/index.js +16 -14
- package/lib/theme/MDXComponents/index.js +45 -4
- package/lib/theme/MDXComponents/styles.css +11 -0
- package/lib/theme/MDXPage/index.js +2 -1
- package/lib/theme/Navbar/index.js +162 -42
- package/lib/theme/Navbar/styles.module.css +10 -3
- package/lib/theme/NavbarItem/DefaultNavbarItem.js +27 -123
- package/lib/theme/NavbarItem/DocNavbarItem.js +7 -8
- package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +19 -12
- package/lib/theme/NavbarItem/DropdownNavbarItem.js +155 -0
- package/lib/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +6 -10
- package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
- package/lib/theme/NavbarItem/index.js +31 -11
- package/lib/theme/{SearchMetadatas → SearchMetadata}/index.js +2 -2
- package/lib/theme/Seo/index.js +10 -7
- package/lib/theme/SkipToContent/index.js +12 -4
- package/lib/theme/SkipToContent/styles.module.css +1 -0
- package/lib/theme/TOC/index.js +9 -29
- package/lib/theme/TOC/styles.module.css +1 -1
- package/lib/theme/TOCCollapsible/index.js +53 -0
- package/lib/theme/TOCCollapsible/styles.module.css +50 -0
- package/lib/theme/TOCInline/index.js +7 -27
- package/lib/theme/TOCItems/index.js +78 -0
- package/lib/theme/Tabs/__tests__/index.test.js +123 -0
- package/lib/theme/Tabs/index.js +73 -50
- package/lib/theme/Tabs/styles.module.css +0 -13
- package/lib/theme/Tag/index.js +40 -0
- package/lib/theme/Tag/styles.module.css +70 -0
- package/lib/theme/TagsListByLetter/index.js +48 -0
- package/lib/theme/TagsListByLetter/styles.module.css +11 -0
- package/lib/theme/TagsListInline/index.js +44 -0
- package/lib/theme/TagsListInline/styles.module.css +15 -0
- package/lib/theme/ThemeProvider/index.js +8 -3
- package/lib/theme/ThemedImage/index.js +6 -7
- package/lib/theme/Toggle/index.js +41 -44
- package/lib/theme/Toggle/styles.module.css +91 -3
- package/lib/theme/UserPreferencesProvider/index.js +9 -12
- package/lib/theme/hooks/useHideableNavbar.js +14 -32
- package/lib/theme/hooks/useTabGroupChoice.js +2 -4
- package/lib/theme/hooks/useTheme.js +3 -5
- package/lib/theme/hooks/useWindowSize.js +33 -20
- package/lib/theme/prism-include-languages.js +4 -3
- package/lib/theme-classic.d.ts +806 -0
- package/lib/translations.js +4 -4
- package/lib/types.d.ts +0 -599
- package/lib/validateThemeConfig.js +230 -246
- package/lib-next/__tests__/validateThemeConfig.test.js +277 -3
- package/lib-next/admonitions.css +35 -0
- package/lib-next/deps.d.ts +13 -0
- package/lib-next/index.js +45 -13
- package/lib-next/prism-include-languages.js +0 -2
- package/lib-next/theme/AnnouncementBar/index.js +9 -18
- package/lib-next/theme/AnnouncementBar/styles.module.css +25 -30
- package/lib-next/theme/BackToTopButton/index.js +131 -0
- package/lib-next/theme/BackToTopButton/styles.module.css +42 -0
- package/lib-next/theme/BlogArchivePage/index.js +80 -0
- package/lib-next/theme/BlogLayout/index.js +40 -0
- package/lib-next/theme/BlogListPage/index.js +17 -25
- package/lib-next/theme/BlogPostAuthor/index.js +46 -0
- package/lib-next/theme/BlogPostAuthor/styles.module.css +12 -0
- package/lib-next/theme/BlogPostAuthors/index.js +34 -0
- package/lib-next/theme/BlogPostAuthors/styles.module.css +11 -0
- package/lib-next/theme/BlogPostItem/index.js +79 -86
- package/lib-next/theme/BlogPostPage/index.js +70 -35
- package/lib-next/theme/BlogSidebar/index.js +11 -13
- package/lib-next/theme/BlogSidebar/styles.module.css +2 -2
- package/lib-next/theme/BlogTagsListPage/index.js +14 -55
- package/lib-next/theme/BlogTagsPostsPage/index.js +29 -39
- package/lib-next/theme/CodeBlock/index.js +17 -149
- package/lib-next/theme/CodeBlock/styles.module.css +6 -9
- package/lib-next/theme/Details/index.js +20 -0
- package/lib-next/theme/Details/styles.module.css +13 -0
- package/lib-next/theme/DocCard/index.js +80 -0
- package/lib-next/theme/DocCard/styles.module.css +43 -0
- package/lib-next/theme/DocCardList/index.js +19 -0
- package/lib-next/theme/DocCategoryGeneratedIndexPage/index.js +49 -0
- package/lib-next/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
- package/lib-next/theme/DocItem/index.js +40 -56
- package/lib-next/theme/DocItem/styles.module.css +5 -9
- package/lib-next/theme/DocItemFooter/index.js +79 -0
- package/lib-next/theme/DocItemFooter/styles.module.css +18 -0
- package/lib-next/theme/DocPage/index.js +46 -47
- package/lib-next/theme/DocPage/styles.module.css +8 -23
- package/lib-next/theme/DocPaginator/index.js +7 -11
- package/lib-next/theme/DocSidebar/index.js +69 -295
- package/lib-next/theme/DocSidebar/styles.module.css +0 -18
- package/lib-next/theme/DocSidebarItem/index.js +217 -0
- package/lib-next/theme/DocSidebarItem/styles.module.css +19 -0
- package/lib-next/theme/DocTagDocListPage/index.js +89 -0
- package/lib-next/theme/DocTagsListPage/index.js +38 -0
- package/lib-next/theme/DocVersionBadge/index.js +27 -0
- package/lib-next/theme/{DocVersionSuggestions → DocVersionBanner}/index.js +51 -36
- package/lib-next/theme/EditThisPage/index.js +6 -1
- package/lib-next/theme/ErrorPageContent.js +35 -0
- package/lib-next/theme/Footer/index.js +27 -5
- package/lib-next/theme/Heading/index.js +25 -29
- package/lib-next/theme/Heading/styles.css +5 -6
- package/lib-next/theme/Heading/styles.module.css +9 -5
- package/lib-next/theme/IconArrow/index.js +2 -2
- package/lib-next/theme/IconClose/index.js +23 -0
- package/lib-next/theme/IconEdit/index.js +2 -2
- package/lib-next/theme/IconExternalLink/index.js +2 -2
- package/lib-next/theme/IconLanguage/index.js +2 -2
- package/lib-next/theme/IconMenu/index.js +2 -2
- package/lib-next/theme/LastUpdated/index.js +3 -2
- package/lib-next/theme/Layout/index.js +3 -1
- package/lib-next/theme/LayoutHead/index.js +18 -23
- package/lib-next/theme/LayoutProviders/index.js +17 -6
- package/lib-next/theme/Logo/index.js +25 -21
- package/lib-next/theme/MDXComponents/index.js +34 -7
- package/lib-next/theme/MDXComponents/styles.css +11 -0
- package/lib-next/theme/MDXPage/index.js +10 -2
- package/lib-next/theme/Navbar/index.js +193 -56
- package/lib-next/theme/Navbar/styles.module.css +10 -3
- package/lib-next/theme/NavbarItem/DefaultNavbarItem.js +45 -147
- package/lib-next/theme/NavbarItem/DocNavbarItem.js +7 -7
- package/lib-next/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +31 -19
- package/lib-next/theme/NavbarItem/DropdownNavbarItem.js +159 -0
- package/lib-next/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +4 -12
- package/lib-next/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
- package/lib-next/theme/NavbarItem/index.js +25 -12
- package/lib-next/theme/{SearchMetadatas → SearchMetadata}/index.js +1 -1
- package/lib-next/theme/Seo/index.js +11 -7
- package/lib-next/theme/SkipToContent/index.js +7 -8
- package/lib-next/theme/SkipToContent/styles.module.css +1 -0
- package/lib-next/theme/TOC/index.js +12 -36
- package/lib-next/theme/TOC/styles.module.css +1 -1
- package/lib-next/theme/TOCCollapsible/index.js +54 -0
- package/lib-next/theme/TOCCollapsible/styles.module.css +50 -0
- package/lib-next/theme/TOCInline/index.js +10 -28
- package/lib-next/theme/TOCItems/index.js +85 -0
- package/lib-next/theme/Tabs/__tests__/index.test.js +142 -0
- package/lib-next/theme/Tabs/index.js +91 -43
- package/lib-next/theme/Tabs/styles.module.css +0 -13
- package/lib-next/theme/Tag/index.js +27 -0
- package/lib-next/theme/Tag/styles.module.css +70 -0
- package/lib-next/theme/TagsListByLetter/index.js +42 -0
- package/lib-next/theme/TagsListByLetter/styles.module.css +11 -0
- package/lib-next/theme/TagsListInline/index.js +31 -0
- package/lib-next/theme/TagsListInline/styles.module.css +15 -0
- package/lib-next/theme/ThemeProvider/index.js +10 -7
- package/lib-next/theme/ThemedImage/index.js +7 -8
- package/lib-next/theme/Toggle/index.js +34 -37
- package/lib-next/theme/Toggle/styles.module.css +91 -3
- package/lib-next/theme/UserPreferencesProvider/index.js +9 -10
- package/lib-next/theme/hooks/useHideableNavbar.js +31 -44
- package/lib-next/theme/hooks/useTabGroupChoice.js +2 -4
- package/lib-next/theme/hooks/useTheme.js +4 -5
- package/lib-next/theme/hooks/useWindowSize.js +34 -20
- package/lib-next/theme/prism-include-languages.js +2 -1
- package/lib-next/theme-classic.d.ts +806 -0
- package/lib-next/translations.js +6 -10
- package/lib-next/types.d.ts +0 -599
- package/lib-next/validateThemeConfig.js +141 -114
- package/package.json +28 -25
- package/src/__tests__/validateThemeConfig.test.js +277 -3
- package/src/admonitions.css +35 -0
- package/src/deps.d.ts +13 -0
- package/src/index.ts +55 -22
- package/src/{prism-include-languages.js → prism-include-languages.ts} +0 -0
- package/src/theme/AnnouncementBar/index.tsx +10 -17
- package/src/theme/AnnouncementBar/styles.module.css +25 -30
- package/src/theme/BackToTopButton/index.tsx +142 -0
- package/src/theme/BackToTopButton/styles.module.css +42 -0
- package/src/theme/BlogArchivePage/index.tsx +91 -0
- package/src/theme/BlogLayout/index.tsx +44 -0
- package/src/theme/BlogListPage/index.tsx +18 -25
- package/src/theme/BlogPostAuthor/index.tsx +49 -0
- package/src/theme/BlogPostAuthor/styles.module.css +12 -0
- package/src/theme/BlogPostAuthors/index.tsx +39 -0
- package/src/theme/BlogPostAuthors/styles.module.css +11 -0
- package/src/theme/BlogPostItem/index.tsx +70 -80
- package/src/theme/BlogPostPage/index.tsx +72 -35
- package/src/theme/BlogSidebar/index.tsx +11 -13
- package/src/theme/BlogSidebar/styles.module.css +2 -2
- package/src/theme/BlogTagsListPage/index.tsx +14 -57
- package/src/theme/BlogTagsPostsPage/index.tsx +29 -39
- package/src/theme/CodeBlock/index.tsx +21 -151
- package/src/theme/CodeBlock/styles.module.css +6 -9
- package/src/theme/Details/index.tsx +24 -0
- package/src/theme/Details/styles.module.css +13 -0
- package/src/theme/DocCard/index.tsx +100 -0
- package/src/theme/DocCard/styles.module.css +43 -0
- package/src/theme/DocCardList/index.tsx +27 -0
- package/src/theme/DocCategoryGeneratedIndexPage/index.tsx +53 -0
- package/src/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
- package/src/theme/DocItem/index.tsx +43 -56
- package/src/theme/DocItem/styles.module.css +5 -9
- package/src/theme/DocItemFooter/index.tsx +91 -0
- package/src/theme/DocItemFooter/styles.module.css +18 -0
- package/src/theme/DocPage/index.tsx +44 -42
- package/src/theme/DocPage/styles.module.css +8 -23
- package/src/theme/DocPaginator/index.tsx +9 -13
- package/src/theme/DocSidebar/index.tsx +80 -307
- package/src/theme/DocSidebar/styles.module.css +0 -18
- package/src/theme/DocSidebarItem/index.tsx +242 -0
- package/src/theme/DocSidebarItem/styles.module.css +19 -0
- package/src/theme/DocTagDocListPage/index.tsx +89 -0
- package/src/theme/DocTagsListPage/index.tsx +41 -0
- package/src/theme/DocVersionBadge/index.tsx +30 -0
- package/src/theme/{DocVersionSuggestions → DocVersionBanner}/index.tsx +74 -44
- package/src/theme/EditThisPage/index.tsx +6 -1
- package/src/theme/ErrorPageContent.tsx +41 -0
- package/src/theme/Footer/index.tsx +30 -6
- package/src/theme/Heading/index.tsx +25 -31
- package/src/theme/Heading/styles.css +5 -6
- package/src/theme/Heading/styles.module.css +9 -5
- package/src/theme/IconArrow/index.tsx +2 -2
- package/src/theme/IconClose/index.tsx +26 -0
- package/src/theme/IconEdit/index.tsx +2 -2
- package/src/theme/IconExternalLink/index.tsx +2 -5
- package/src/theme/IconLanguage/index.tsx +2 -6
- package/src/theme/IconMenu/index.tsx +3 -3
- package/src/theme/LastUpdated/index.tsx +3 -2
- package/src/theme/Layout/index.tsx +3 -1
- package/src/theme/LayoutHead/index.tsx +18 -17
- package/src/theme/LayoutProviders/index.tsx +17 -6
- package/src/theme/Logo/index.tsx +21 -17
- package/src/theme/MDXComponents/index.tsx +39 -5
- package/src/theme/MDXComponents/styles.css +11 -0
- package/src/theme/MDXPage/index.tsx +10 -2
- package/src/theme/Navbar/index.tsx +203 -61
- package/src/theme/Navbar/styles.module.css +10 -3
- package/src/theme/NavbarItem/DefaultNavbarItem.tsx +42 -154
- package/src/theme/NavbarItem/DocNavbarItem.tsx +12 -16
- package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx +33 -21
- package/src/theme/NavbarItem/DocsVersionNavbarItem.tsx +7 -3
- package/src/theme/NavbarItem/DropdownNavbarItem.tsx +181 -0
- package/src/theme/NavbarItem/{LocaleDropdownNavbarItem.tsx → LocaleDropdownNavbarItem/index.tsx} +8 -9
- package/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
- package/src/theme/NavbarItem/index.tsx +41 -16
- package/src/theme/{SearchMetadatas → SearchMetadata}/index.tsx +2 -2
- package/src/theme/Seo/index.tsx +7 -4
- package/src/theme/SkipToContent/index.tsx +7 -8
- package/src/theme/SkipToContent/styles.module.css +1 -0
- package/src/theme/TOC/index.tsx +12 -41
- package/src/theme/TOC/styles.module.css +1 -1
- package/src/theme/TOCCollapsible/index.tsx +58 -0
- package/src/theme/TOCCollapsible/styles.module.css +50 -0
- package/src/theme/TOCInline/index.tsx +13 -32
- package/src/theme/TOCItems/index.tsx +96 -0
- package/src/theme/Tabs/__tests__/index.test.tsx +129 -0
- package/src/theme/Tabs/index.tsx +93 -49
- package/src/theme/Tabs/styles.module.css +0 -13
- package/src/theme/Tag/index.tsx +31 -0
- package/src/theme/Tag/styles.module.css +70 -0
- package/src/theme/TagsListByLetter/index.tsx +45 -0
- package/src/theme/TagsListByLetter/styles.module.css +11 -0
- package/src/theme/TagsListInline/index.tsx +35 -0
- package/src/theme/TagsListInline/styles.module.css +15 -0
- package/src/theme/ThemeProvider/index.tsx +6 -2
- package/src/theme/ThemedImage/index.tsx +8 -8
- package/src/theme/Toggle/index.tsx +36 -43
- package/src/theme/Toggle/styles.module.css +91 -3
- package/src/theme/UserPreferencesProvider/index.tsx +9 -11
- package/src/theme/hooks/useHideableNavbar.ts +32 -45
- package/src/theme/hooks/useTabGroupChoice.ts +4 -4
- package/src/theme/hooks/useTheme.ts +4 -5
- package/src/theme/hooks/useWindowSize.ts +38 -20
- package/src/theme/prism-include-languages.ts +3 -2
- package/src/theme-classic.d.ts +806 -0
- package/src/translations.ts +8 -10
- package/src/types.d.ts +0 -599
- package/src/{validateThemeConfig.js → validateThemeConfig.ts} +151 -94
- package/tsconfig.json +1 -2
- package/codeTranslations/README.md +0 -20
- package/codeTranslations/ar.json +0 -57
- package/codeTranslations/base.json +0 -112
- package/codeTranslations/bn.json +0 -56
- package/codeTranslations/da.json +0 -57
- package/codeTranslations/de.json +0 -57
- package/codeTranslations/es.json +0 -57
- package/codeTranslations/fa.json +0 -57
- package/codeTranslations/fil.json +0 -57
- package/codeTranslations/fr.json +0 -57
- package/codeTranslations/he.json +0 -57
- package/codeTranslations/hi.json +0 -57
- package/codeTranslations/ja.json +0 -57
- package/codeTranslations/ko.json +0 -57
- package/codeTranslations/pl.json +0 -57
- package/codeTranslations/pt-BR.json +0 -57
- package/codeTranslations/pt-PT.json +0 -57
- package/codeTranslations/ru.json +0 -57
- package/codeTranslations/tr.json +0 -57
- package/codeTranslations/vi.json +0 -57
- package/codeTranslations/zh-Hans.json +0 -57
- package/codeTranslations/zh-Hant.json +0 -57
- package/lib/theme/Toggle/styles.css +0 -103
- package/lib/theme/hooks/useAnnouncementBar.js +0 -63
- package/lib/theme/hooks/useContextualSearchFilters.js +0 -47
- package/lib/theme/hooks/useScrollPosition.js +0 -49
- package/lib/theme/hooks/useTOCHighlight.js +0 -87
- package/lib-next/theme/Toggle/styles.css +0 -103
- package/lib-next/theme/hooks/useAnnouncementBar.js +0 -49
- package/lib-next/theme/hooks/useContextualSearchFilters.js +0 -41
- package/lib-next/theme/hooks/useScrollPosition.js +0 -38
- package/lib-next/theme/hooks/useTOCHighlight.js +0 -84
- package/src/theme/Toggle/styles.css +0 -103
- package/src/theme/hooks/useAnnouncementBar.ts +0 -58
- package/src/theme/hooks/useContextualSearchFilters.ts +0 -52
- package/src/theme/hooks/useScrollPosition.ts +0 -45
- package/src/theme/hooks/useTOCHighlight.ts +0 -98
- package/update-code-translations.js +0 -239
- package/update-code-translations.test.js +0 -33
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = DocCard;
|
|
7
|
+
|
|
8
|
+
var _react = _interopRequireDefault(require("react"));
|
|
9
|
+
|
|
10
|
+
var _Link = _interopRequireDefault(require("@docusaurus/Link"));
|
|
11
|
+
|
|
12
|
+
var _themeCommon = require("@docusaurus/theme-common");
|
|
13
|
+
|
|
14
|
+
var _clsx = _interopRequireDefault(require("clsx"));
|
|
15
|
+
|
|
16
|
+
var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
|
|
17
|
+
|
|
18
|
+
var _isInternalUrl = _interopRequireDefault(require("@docusaurus/isInternalUrl"));
|
|
19
|
+
|
|
20
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
24
|
+
*
|
|
25
|
+
* This source code is licensed under the MIT license found in the
|
|
26
|
+
* LICENSE file in the root directory of this source tree.
|
|
27
|
+
*/
|
|
28
|
+
function CardContainer({
|
|
29
|
+
href,
|
|
30
|
+
children
|
|
31
|
+
}) {
|
|
32
|
+
const className = (0, _clsx.default)('card margin-bottom--lg padding--lg', _stylesModule.default.cardContainer, href && _stylesModule.default.cardContainerLink);
|
|
33
|
+
return href ? <_Link.default href={href} className={className}>
|
|
34
|
+
{children}
|
|
35
|
+
</_Link.default> : <div className={className}>{children}</div>;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
function CardLayout({
|
|
39
|
+
href,
|
|
40
|
+
icon,
|
|
41
|
+
title,
|
|
42
|
+
description
|
|
43
|
+
}) {
|
|
44
|
+
return <CardContainer href={href}>
|
|
45
|
+
<h2 className={(0, _clsx.default)('text--truncate', _stylesModule.default.cardTitle)} title={title}>
|
|
46
|
+
{icon} {title}
|
|
47
|
+
</h2>
|
|
48
|
+
<div className={(0, _clsx.default)('text--truncate', _stylesModule.default.cardDescription)} title={description}>
|
|
49
|
+
{description}
|
|
50
|
+
</div>
|
|
51
|
+
</CardContainer>;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
function CardCategory({
|
|
55
|
+
item
|
|
56
|
+
}) {
|
|
57
|
+
const href = (0, _themeCommon.findFirstCategoryLink)(item);
|
|
58
|
+
return <CardLayout href={href} icon="🗃️" title={item.label} description={`${item.items.length} items`} />;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
function CardLink({
|
|
62
|
+
item
|
|
63
|
+
}) {
|
|
64
|
+
var _item$docId;
|
|
65
|
+
|
|
66
|
+
const icon = (0, _isInternalUrl.default)(item.href) ? '📄️' : '🔗';
|
|
67
|
+
const doc = (0, _themeCommon.useDocById)((_item$docId = item.docId) !== null && _item$docId !== void 0 ? _item$docId : undefined);
|
|
68
|
+
return <CardLayout href={item.href} icon={icon} title={item.label} description={doc === null || doc === void 0 ? void 0 : doc.description} />;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
function DocCard({
|
|
72
|
+
item
|
|
73
|
+
}) {
|
|
74
|
+
switch (item.type) {
|
|
75
|
+
case 'link':
|
|
76
|
+
return <CardLink item={item} />;
|
|
77
|
+
|
|
78
|
+
case 'category':
|
|
79
|
+
return <CardCategory item={item} />;
|
|
80
|
+
|
|
81
|
+
default:
|
|
82
|
+
throw new Error(`unknown item type ${JSON.stringify(item)}`);
|
|
83
|
+
}
|
|
84
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
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
|
+
.cardContainer {
|
|
9
|
+
height: 8rem;
|
|
10
|
+
|
|
11
|
+
color: var(--ifm-color-emphasis-800);
|
|
12
|
+
--ifm-link-color: var(--ifm-color-emphasis-800);
|
|
13
|
+
--ifm-link-hover-color: var(--ifm-color-emphasis-800);
|
|
14
|
+
--ifm-link-hover-decoration: none;
|
|
15
|
+
|
|
16
|
+
/* box-shadow: var(--ifm-global-shadow-lw); */
|
|
17
|
+
box-shadow: 0 1.5px 3px 0 rgba(0, 0, 0, 0.15);
|
|
18
|
+
border: 1px solid var(--ifm-color-emphasis-200);
|
|
19
|
+
transition: box-shadow var(--ifm-transition-fast) ease,
|
|
20
|
+
background-color var(--ifm-transition-fast) ease;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
.cardContainer.cardContainerLink:hover {
|
|
24
|
+
/* box-shadow: var(--ifm-global-shadow-md); */
|
|
25
|
+
box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2);
|
|
26
|
+
}
|
|
27
|
+
html[data-theme='dark'] .cardContainer.cardContainerLink:hover {
|
|
28
|
+
--ifm-card-background-color: #2d2d2d; /* original, non-hovered color is #242526 */
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
.cardContainer:not(.cardContainerLink) {
|
|
32
|
+
cursor: not-allowed;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
.cardTitle {
|
|
36
|
+
font-size: 1.2rem;
|
|
37
|
+
min-height: 1.2rem;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
.cardDescription {
|
|
41
|
+
font-size: 0.8rem;
|
|
42
|
+
min-height: 0.8rem;
|
|
43
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = DocCardList;
|
|
7
|
+
|
|
8
|
+
var _react = _interopRequireDefault(require("react"));
|
|
9
|
+
|
|
10
|
+
var _DocCard = _interopRequireDefault(require("@theme/DocCard"));
|
|
11
|
+
|
|
12
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
16
|
+
*
|
|
17
|
+
* This source code is licensed under the MIT license found in the
|
|
18
|
+
* LICENSE file in the root directory of this source tree.
|
|
19
|
+
*/
|
|
20
|
+
function DocCardList({
|
|
21
|
+
items
|
|
22
|
+
}) {
|
|
23
|
+
return <div className="row">
|
|
24
|
+
{items.map((item, index) => <article key={index} className="col col--6">
|
|
25
|
+
<_DocCard.default item={item} />
|
|
26
|
+
</article>)}
|
|
27
|
+
</div>;
|
|
28
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = DocCategoryGeneratedIndexPage;
|
|
7
|
+
|
|
8
|
+
var _react = _interopRequireDefault(require("react"));
|
|
9
|
+
|
|
10
|
+
var _themeCommon = require("@docusaurus/theme-common");
|
|
11
|
+
|
|
12
|
+
var _DocCardList = _interopRequireDefault(require("@theme/DocCardList"));
|
|
13
|
+
|
|
14
|
+
var _DocPaginator = _interopRequireDefault(require("@theme/DocPaginator"));
|
|
15
|
+
|
|
16
|
+
var _Seo = _interopRequireDefault(require("@theme/Seo"));
|
|
17
|
+
|
|
18
|
+
var _DocVersionBanner = _interopRequireDefault(require("@theme/DocVersionBanner"));
|
|
19
|
+
|
|
20
|
+
var _DocVersionBadge = _interopRequireDefault(require("@theme/DocVersionBadge"));
|
|
21
|
+
|
|
22
|
+
var _Heading = require("@theme/Heading");
|
|
23
|
+
|
|
24
|
+
var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
|
|
25
|
+
|
|
26
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
30
|
+
*
|
|
31
|
+
* This source code is licensed under the MIT license found in the
|
|
32
|
+
* LICENSE file in the root directory of this source tree.
|
|
33
|
+
*/
|
|
34
|
+
function DocCategoryGeneratedIndexPage({
|
|
35
|
+
categoryGeneratedIndex
|
|
36
|
+
}) {
|
|
37
|
+
const category = (0, _themeCommon.useCurrentSidebarCategory)();
|
|
38
|
+
return <>
|
|
39
|
+
<_Seo.default title={categoryGeneratedIndex.title} description={categoryGeneratedIndex.description} />
|
|
40
|
+
<div className={_stylesModule.default.generatedIndexPage}>
|
|
41
|
+
<_DocVersionBanner.default />
|
|
42
|
+
<_DocVersionBadge.default />
|
|
43
|
+
<header>
|
|
44
|
+
<_Heading.MainHeading className={_stylesModule.default.title}>
|
|
45
|
+
{categoryGeneratedIndex.title}
|
|
46
|
+
</_Heading.MainHeading>
|
|
47
|
+
{categoryGeneratedIndex.description && <p>{categoryGeneratedIndex.description}</p>}
|
|
48
|
+
</header>
|
|
49
|
+
<main className="margin-top--lg">
|
|
50
|
+
<_DocCardList.default items={category.items} />
|
|
51
|
+
</main>
|
|
52
|
+
<footer className="margin-top--lg">
|
|
53
|
+
<_DocPaginator.default previous={categoryGeneratedIndex.navigation.previous} next={categoryGeneratedIndex.navigation.next} />
|
|
54
|
+
</footer>
|
|
55
|
+
</div>
|
|
56
|
+
</>;
|
|
57
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
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
|
+
@media (min-width: 997px) {
|
|
9
|
+
.generatedIndexPage {
|
|
10
|
+
max-width: 75% !important;
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
/* Duplicated from .markdown h1 */
|
|
15
|
+
.title {
|
|
16
|
+
--ifm-h1-font-size: 3rem;
|
|
17
|
+
margin-bottom: calc(1.25 * var(--ifm-leading));
|
|
18
|
+
}
|
|
@@ -3,29 +3,33 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.default =
|
|
6
|
+
exports.default = DocItem;
|
|
7
7
|
|
|
8
8
|
var _react = _interopRequireDefault(require("react"));
|
|
9
9
|
|
|
10
|
+
var _clsx = _interopRequireDefault(require("clsx"));
|
|
11
|
+
|
|
12
|
+
var _useWindowSize = _interopRequireDefault(require("@theme/hooks/useWindowSize"));
|
|
13
|
+
|
|
10
14
|
var _DocPaginator = _interopRequireDefault(require("@theme/DocPaginator"));
|
|
11
15
|
|
|
12
|
-
var
|
|
16
|
+
var _DocVersionBanner = _interopRequireDefault(require("@theme/DocVersionBanner"));
|
|
17
|
+
|
|
18
|
+
var _DocVersionBadge = _interopRequireDefault(require("@theme/DocVersionBadge"));
|
|
13
19
|
|
|
14
20
|
var _Seo = _interopRequireDefault(require("@theme/Seo"));
|
|
15
21
|
|
|
16
|
-
var
|
|
22
|
+
var _DocItemFooter = _interopRequireDefault(require("@theme/DocItemFooter"));
|
|
17
23
|
|
|
18
24
|
var _TOC = _interopRequireDefault(require("@theme/TOC"));
|
|
19
25
|
|
|
20
|
-
var
|
|
26
|
+
var _TOCCollapsible = _interopRequireDefault(require("@theme/TOCCollapsible"));
|
|
21
27
|
|
|
22
28
|
var _Heading = require("@theme/Heading");
|
|
23
29
|
|
|
24
|
-
var _clsx = _interopRequireDefault(require("clsx"));
|
|
25
|
-
|
|
26
30
|
var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
|
|
27
31
|
|
|
28
|
-
var
|
|
32
|
+
var _themeCommon = require("@docusaurus/theme-common");
|
|
29
33
|
|
|
30
34
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
31
35
|
|
|
@@ -47,31 +51,21 @@ function DocItem(props) {
|
|
|
47
51
|
image,
|
|
48
52
|
keywords,
|
|
49
53
|
hide_title: hideTitle,
|
|
50
|
-
hide_table_of_contents: hideTableOfContents
|
|
54
|
+
hide_table_of_contents: hideTableOfContents,
|
|
55
|
+
toc_min_heading_level: tocMinHeadingLevel,
|
|
56
|
+
toc_max_heading_level: tocMaxHeadingLevel
|
|
51
57
|
} = frontMatter;
|
|
52
58
|
const {
|
|
53
59
|
description,
|
|
54
|
-
title
|
|
55
|
-
|
|
56
|
-
lastUpdatedAt,
|
|
57
|
-
formattedLastUpdatedAt,
|
|
58
|
-
lastUpdatedBy
|
|
59
|
-
} = metadata;
|
|
60
|
-
const {
|
|
61
|
-
pluginId
|
|
62
|
-
} = (0, _useDocs.useActivePlugin)({
|
|
63
|
-
failfast: true
|
|
64
|
-
});
|
|
65
|
-
const versions = (0, _useDocs.useVersions)(pluginId);
|
|
66
|
-
const version = (0, _useDocs.useActiveVersion)(pluginId); // If site is not versioned or only one version is included
|
|
67
|
-
// we don't show the version badge
|
|
68
|
-
// See https://github.com/facebook/docusaurus/issues/3362
|
|
69
|
-
|
|
70
|
-
const showVersionBadge = versions.length > 1; // We only add a title if:
|
|
60
|
+
title
|
|
61
|
+
} = metadata; // We only add a title if:
|
|
71
62
|
// - user asks to hide it with frontmatter
|
|
72
63
|
// - the markdown content does not already contain a top-level h1 heading
|
|
73
64
|
|
|
74
65
|
const shouldAddTitle = !hideTitle && typeof DocContent.contentTitle === 'undefined';
|
|
66
|
+
const windowSize = (0, _useWindowSize.default)();
|
|
67
|
+
const canRenderTOC = !hideTableOfContents && DocContent.toc && DocContent.toc.length > 0;
|
|
68
|
+
const renderTocDesktop = canRenderTOC && (windowSize === 'desktop' || windowSize === 'ssr');
|
|
75
69
|
return <>
|
|
76
70
|
<_Seo.default {...{
|
|
77
71
|
title,
|
|
@@ -84,14 +78,14 @@ function DocItem(props) {
|
|
|
84
78
|
<div className={(0, _clsx.default)('col', {
|
|
85
79
|
[_stylesModule.default.docItemCol]: !hideTableOfContents
|
|
86
80
|
})}>
|
|
87
|
-
<
|
|
81
|
+
<_DocVersionBanner.default />
|
|
88
82
|
<div className={_stylesModule.default.docItemContainer}>
|
|
89
83
|
<article>
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
84
|
+
<_DocVersionBadge.default />
|
|
85
|
+
|
|
86
|
+
{canRenderTOC && <_TOCCollapsible.default toc={DocContent.toc} minHeadingLevel={tocMinHeadingLevel} maxHeadingLevel={tocMaxHeadingLevel} className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docTocMobile, _stylesModule.default.tocMobile)} />}
|
|
93
87
|
|
|
94
|
-
<div className=
|
|
88
|
+
<div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docMarkdown, 'markdown')}>
|
|
95
89
|
{
|
|
96
90
|
/*
|
|
97
91
|
Title can be declared inside md content or declared through frontmatter and added manually
|
|
@@ -104,26 +98,15 @@ function DocItem(props) {
|
|
|
104
98
|
<DocContent />
|
|
105
99
|
</div>
|
|
106
100
|
|
|
107
|
-
|
|
108
|
-
<div className="col">
|
|
109
|
-
{editUrl && <_EditThisPage.default editUrl={editUrl} />}
|
|
110
|
-
</div>
|
|
111
|
-
|
|
112
|
-
<div className={(0, _clsx.default)('col', _stylesModule.default.lastUpdated)}>
|
|
113
|
-
{(lastUpdatedAt || lastUpdatedBy) && <_LastUpdated.default lastUpdatedAt={lastUpdatedAt} formattedLastUpdatedAt={formattedLastUpdatedAt} lastUpdatedBy={lastUpdatedBy} />}
|
|
114
|
-
</div>
|
|
115
|
-
</footer>}
|
|
101
|
+
<_DocItemFooter.default {...props} />
|
|
116
102
|
</article>
|
|
117
103
|
|
|
118
|
-
<_DocPaginator.default metadata={metadata} />
|
|
104
|
+
<_DocPaginator.default previous={metadata.previous} next={metadata.next} />
|
|
119
105
|
</div>
|
|
120
106
|
</div>
|
|
121
|
-
{
|
|
122
|
-
<_TOC.default toc={DocContent.toc} />
|
|
107
|
+
{renderTocDesktop && <div className="col col--3">
|
|
108
|
+
<_TOC.default toc={DocContent.toc} minHeadingLevel={tocMinHeadingLevel} maxHeadingLevel={tocMaxHeadingLevel} className={_themeCommon.ThemeClassNames.docs.docTocDesktop} />
|
|
123
109
|
</div>}
|
|
124
110
|
</div>
|
|
125
111
|
</>;
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
var _default = DocItem;
|
|
129
|
-
exports.default = _default;
|
|
112
|
+
}
|
|
@@ -5,22 +5,18 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
+
.docItemContainer article > *:first-child,
|
|
8
9
|
.docItemContainer header + * {
|
|
9
10
|
margin-top: 0;
|
|
10
11
|
}
|
|
11
12
|
|
|
12
|
-
|
|
13
|
-
margin-top: 0.2rem;
|
|
14
|
-
font-style: italic;
|
|
15
|
-
font-size: smaller;
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
@media only screen and (min-width: 997px) {
|
|
13
|
+
@media (min-width: 997px) {
|
|
19
14
|
.docItemCol {
|
|
20
15
|
max-width: 75% !important;
|
|
21
16
|
}
|
|
22
17
|
|
|
23
|
-
|
|
24
|
-
|
|
18
|
+
/* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
|
|
19
|
+
.tocMobile {
|
|
20
|
+
display: none;
|
|
25
21
|
}
|
|
26
22
|
}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = DocItemFooter;
|
|
7
|
+
|
|
8
|
+
var _react = _interopRequireDefault(require("react"));
|
|
9
|
+
|
|
10
|
+
var _clsx = _interopRequireDefault(require("clsx"));
|
|
11
|
+
|
|
12
|
+
var _LastUpdated = _interopRequireDefault(require("@theme/LastUpdated"));
|
|
13
|
+
|
|
14
|
+
var _EditThisPage = _interopRequireDefault(require("@theme/EditThisPage"));
|
|
15
|
+
|
|
16
|
+
var _TagsListInline = _interopRequireDefault(require("@theme/TagsListInline"));
|
|
17
|
+
|
|
18
|
+
var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
|
|
19
|
+
|
|
20
|
+
var _themeCommon = require("@docusaurus/theme-common");
|
|
21
|
+
|
|
22
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
26
|
+
*
|
|
27
|
+
* This source code is licensed under the MIT license found in the
|
|
28
|
+
* LICENSE file in the root directory of this source tree.
|
|
29
|
+
*/
|
|
30
|
+
function TagsRow(props) {
|
|
31
|
+
return <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docFooterTagsRow, 'row margin-bottom--sm')}>
|
|
32
|
+
<div className="col">
|
|
33
|
+
<_TagsListInline.default {...props} />
|
|
34
|
+
</div>
|
|
35
|
+
</div>;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
function EditMetaRow({
|
|
39
|
+
editUrl,
|
|
40
|
+
lastUpdatedAt,
|
|
41
|
+
lastUpdatedBy,
|
|
42
|
+
formattedLastUpdatedAt
|
|
43
|
+
}) {
|
|
44
|
+
return <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docFooterEditMetaRow, 'row')}>
|
|
45
|
+
<div className="col">{editUrl && <_EditThisPage.default editUrl={editUrl} />}</div>
|
|
46
|
+
|
|
47
|
+
<div className={(0, _clsx.default)('col', _stylesModule.default.lastUpdated)}>
|
|
48
|
+
{(lastUpdatedAt || lastUpdatedBy) && <_LastUpdated.default lastUpdatedAt={lastUpdatedAt} formattedLastUpdatedAt={formattedLastUpdatedAt} lastUpdatedBy={lastUpdatedBy} />}
|
|
49
|
+
</div>
|
|
50
|
+
</div>;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
function DocItemFooter(props) {
|
|
54
|
+
const {
|
|
55
|
+
content: DocContent
|
|
56
|
+
} = props;
|
|
57
|
+
const {
|
|
58
|
+
metadata
|
|
59
|
+
} = DocContent;
|
|
60
|
+
const {
|
|
61
|
+
editUrl,
|
|
62
|
+
lastUpdatedAt,
|
|
63
|
+
formattedLastUpdatedAt,
|
|
64
|
+
lastUpdatedBy,
|
|
65
|
+
tags
|
|
66
|
+
} = metadata;
|
|
67
|
+
const canDisplayTagsRow = tags.length > 0;
|
|
68
|
+
const canDisplayEditMetaRow = !!(editUrl || lastUpdatedAt || lastUpdatedBy);
|
|
69
|
+
const canDisplayFooter = canDisplayTagsRow || canDisplayEditMetaRow;
|
|
70
|
+
|
|
71
|
+
if (!canDisplayFooter) {
|
|
72
|
+
return null;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
return <footer className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docFooter, 'docusaurus-mt-lg')}>
|
|
76
|
+
{canDisplayTagsRow && <TagsRow tags={tags} />}
|
|
77
|
+
{canDisplayEditMetaRow && <EditMetaRow editUrl={editUrl} lastUpdatedAt={lastUpdatedAt} lastUpdatedBy={lastUpdatedBy} formattedLastUpdatedAt={formattedLastUpdatedAt} />}
|
|
78
|
+
</footer>;
|
|
79
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
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
|
+
.lastUpdated {
|
|
9
|
+
margin-top: 0.2rem;
|
|
10
|
+
font-style: italic;
|
|
11
|
+
font-size: smaller;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
@media (min-width: 997px) {
|
|
15
|
+
.lastUpdated {
|
|
16
|
+
text-align: right;
|
|
17
|
+
}
|
|
18
|
+
}
|
|
@@ -9,8 +9,6 @@ var _react = _interopRequireWildcard(require("react"));
|
|
|
9
9
|
|
|
10
10
|
var _react2 = require("@mdx-js/react");
|
|
11
11
|
|
|
12
|
-
var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
|
|
13
|
-
|
|
14
12
|
var _renderRoutes = _interopRequireDefault(require("@docusaurus/renderRoutes"));
|
|
15
13
|
|
|
16
14
|
var _Layout = _interopRequireDefault(require("@theme/Layout"));
|
|
@@ -23,6 +21,8 @@ var _NotFound = _interopRequireDefault(require("@theme/NotFound"));
|
|
|
23
21
|
|
|
24
22
|
var _IconArrow = _interopRequireDefault(require("@theme/IconArrow"));
|
|
25
23
|
|
|
24
|
+
var _BackToTopButton = _interopRequireDefault(require("@theme/BackToTopButton"));
|
|
25
|
+
|
|
26
26
|
var _router = require("@docusaurus/router");
|
|
27
27
|
|
|
28
28
|
var _Translate = require("@docusaurus/Translate");
|
|
@@ -33,6 +33,8 @@ var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
|
|
|
33
33
|
|
|
34
34
|
var _themeCommon = require("@docusaurus/theme-common");
|
|
35
35
|
|
|
36
|
+
var _Head = _interopRequireDefault(require("@docusaurus/Head"));
|
|
37
|
+
|
|
36
38
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
37
39
|
|
|
38
40
|
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
@@ -45,55 +47,17 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
|
|
|
45
47
|
* This source code is licensed under the MIT license found in the
|
|
46
48
|
* LICENSE file in the root directory of this source tree.
|
|
47
49
|
*/
|
|
48
|
-
function getSidebar({
|
|
49
|
-
versionMetadata,
|
|
50
|
-
currentDocRoute
|
|
51
|
-
}) {
|
|
52
|
-
function addTrailingSlash(str) {
|
|
53
|
-
return str.endsWith('/') ? str : `${str}/`;
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
function removeTrailingSlash(str) {
|
|
57
|
-
return str.endsWith('/') ? str.slice(0, -1) : str;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
const {
|
|
61
|
-
permalinkToSidebar,
|
|
62
|
-
docsSidebars
|
|
63
|
-
} = versionMetadata; // With/without trailingSlash, we should always be able to get the appropriate sidebar
|
|
64
|
-
// note: docs plugin permalinks currently never have trailing slashes
|
|
65
|
-
// trailingSlash is handled globally at the framework level, not plugin level
|
|
66
|
-
|
|
67
|
-
const sidebarName = permalinkToSidebar[currentDocRoute.path] || permalinkToSidebar[addTrailingSlash(currentDocRoute.path)] || permalinkToSidebar[removeTrailingSlash(currentDocRoute.path)];
|
|
68
|
-
const sidebar = docsSidebars[sidebarName];
|
|
69
|
-
return {
|
|
70
|
-
sidebar,
|
|
71
|
-
sidebarName
|
|
72
|
-
};
|
|
73
|
-
}
|
|
74
|
-
|
|
75
50
|
function DocPageContent({
|
|
76
51
|
currentDocRoute,
|
|
77
52
|
versionMetadata,
|
|
78
|
-
children
|
|
53
|
+
children,
|
|
54
|
+
sidebarName
|
|
79
55
|
}) {
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
const {
|
|
83
|
-
siteConfig,
|
|
84
|
-
isClient
|
|
85
|
-
} = (0, _useDocusaurusContext.default)();
|
|
56
|
+
const sidebar = (0, _themeCommon.useDocsSidebar)();
|
|
86
57
|
const {
|
|
87
58
|
pluginId,
|
|
88
59
|
version
|
|
89
60
|
} = versionMetadata;
|
|
90
|
-
const {
|
|
91
|
-
sidebarName,
|
|
92
|
-
sidebar
|
|
93
|
-
} = getSidebar({
|
|
94
|
-
versionMetadata,
|
|
95
|
-
currentDocRoute
|
|
96
|
-
});
|
|
97
61
|
const [hiddenSidebarContainer, setHiddenSidebarContainer] = (0, _react.useState)(false);
|
|
98
62
|
const [hiddenSidebar, setHiddenSidebar] = (0, _react.useState)(false);
|
|
99
63
|
const toggleSidebar = (0, _react.useCallback)(() => {
|
|
@@ -101,13 +65,15 @@ function DocPageContent({
|
|
|
101
65
|
setHiddenSidebar(false);
|
|
102
66
|
}
|
|
103
67
|
|
|
104
|
-
setHiddenSidebarContainer(!
|
|
68
|
+
setHiddenSidebarContainer(value => !value);
|
|
105
69
|
}, [hiddenSidebar]);
|
|
106
|
-
return <_Layout.default
|
|
70
|
+
return <_Layout.default wrapperClassName={_themeCommon.ThemeClassNames.wrapper.docsPages} pageClassName={_themeCommon.ThemeClassNames.page.docsDocPage} searchMetadata={{
|
|
107
71
|
version,
|
|
108
72
|
tag: (0, _themeCommon.docVersionSearchTag)(pluginId, version)
|
|
109
73
|
}}>
|
|
110
74
|
<div className={_stylesModule.default.docPage}>
|
|
75
|
+
<_BackToTopButton.default />
|
|
76
|
+
|
|
111
77
|
{sidebar && <aside className={(0, _clsx.default)(_stylesModule.default.docSidebarContainer, {
|
|
112
78
|
[_stylesModule.default.docSidebarContainerHidden]: hiddenSidebarContainer
|
|
113
79
|
})} onTransitionEnd={e => {
|
|
@@ -121,7 +87,7 @@ function DocPageContent({
|
|
|
121
87
|
}}>
|
|
122
88
|
<_DocSidebar.default key={// Reset sidebar state on sidebar changes
|
|
123
89
|
// See https://github.com/facebook/docusaurus/issues/3414
|
|
124
|
-
sidebarName} sidebar={sidebar} path={currentDocRoute.path}
|
|
90
|
+
sidebarName} sidebar={sidebar} path={currentDocRoute.path} onCollapse={toggleSidebar} isHidden={hiddenSidebar} />
|
|
125
91
|
|
|
126
92
|
{hiddenSidebar && <div className={_stylesModule.default.collapsedDocSidebar} title={(0, _Translate.translate)({
|
|
127
93
|
id: 'theme.docs.sidebar.expandButtonTitle',
|
|
@@ -159,12 +125,29 @@ function DocPage(props) {
|
|
|
159
125
|
const currentDocRoute = docRoutes.find(docRoute => (0, _router.matchPath)(location.pathname, docRoute));
|
|
160
126
|
|
|
161
127
|
if (!currentDocRoute) {
|
|
162
|
-
return <_NotFound.default
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
128
|
+
return <_NotFound.default />;
|
|
129
|
+
} // For now, the sidebarName is added as route config: not ideal!
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
const sidebarName = currentDocRoute.sidebar;
|
|
133
|
+
const sidebar = sidebarName ? versionMetadata.docsSidebars[sidebarName] : null;
|
|
134
|
+
return <>
|
|
135
|
+
<_Head.default>
|
|
136
|
+
{
|
|
137
|
+
/* TODO we should add a core addRoute({htmlClassName}) generic plugin option */
|
|
138
|
+
}
|
|
139
|
+
<html className={versionMetadata.className} />
|
|
140
|
+
</_Head.default>
|
|
141
|
+
<_themeCommon.DocsVersionProvider version={versionMetadata}>
|
|
142
|
+
<_themeCommon.DocsSidebarProvider sidebar={sidebar}>
|
|
143
|
+
<DocPageContent currentDocRoute={currentDocRoute} versionMetadata={versionMetadata} sidebarName={sidebarName}>
|
|
144
|
+
{(0, _renderRoutes.default)(docRoutes, {
|
|
145
|
+
versionMetadata
|
|
146
|
+
})}
|
|
147
|
+
</DocPageContent>
|
|
148
|
+
</_themeCommon.DocsSidebarProvider>
|
|
149
|
+
</_themeCommon.DocsVersionProvider>
|
|
150
|
+
</>;
|
|
168
151
|
}
|
|
169
152
|
|
|
170
153
|
var _default = DocPage;
|