You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by mo...@apache.org on 2023/06/12 02:48:59 UTC
[doris-website] branch master updated: (feature) upgrade to docusaurus 2.4.1 (#238)
This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new ec605e2e22a (feature) upgrade to docusaurus 2.4.1 (#238)
ec605e2e22a is described below
commit ec605e2e22abe88ae120a739a22f2dfe06d70097
Author: Jeffrey <co...@gmail.com>
AuthorDate: Mon Jun 12 10:48:54 2023 +0800
(feature) upgrade to docusaurus 2.4.1 (#238)
---
.gitignore | 8 ++
docusaurus.config.js | 12 +-
doris | 1 +
package.json | 24 ++--
prepare_local_dev.sh | 44 +++++++
src/pages/index.tsx | 2 +-
src/theme/AnnouncementBar/index.tsx | 5 +-
src/theme/BlogLayout/style.scss | 2 +-
src/theme/BlogPostItem/index.tsx | 8 +-
src/theme/Footer/Links/MultiColumn/index.tsx | 2 +-
src/theme/Layout/index.tsx | 23 ++--
src/theme/Navbar/Content/index.tsx | 137 ++++++++++-----------
.../Navbar/MobileSidebar/PrimaryMenu/index.tsx | 58 ++++-----
.../NavbarItem/LocaleDropdownNavbarItem/index.tsx | 5 +-
static/images/running_profile.png | Bin 52197 -> 198489 bytes
versions.json | 1 +
16 files changed, 186 insertions(+), 146 deletions(-)
diff --git a/.gitignore b/.gitignore
index 0d777b094c7..ccc9234be7d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,3 +25,11 @@ yarn-error.log*
*.zip
yarn.lock
+
+sidebars.json
+sidebarsCommunity.json
+i18n/zh-CN/docusaurus-plugin-content-docs/current
+i18n/zh-CN/docusaurus-plugin-content-docs/current.json
+i18n/zh-CN/docusaurus-plugin-content-docs-community/current
+docs/
+community/
\ No newline at end of file
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 0d05d006e46..3c2b3ebb90a 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -1,7 +1,8 @@
-const lightCodeTheme = require('prism-react-renderer/themes/github');
+const themes = require('prism-react-renderer').themes;
const { ssrTemplate } = require('./config/ssrTemplate');
const customDocusaurusPlugin = require('./config/custom-docusaurus-plugin');
const versionsPlugin = require('./config/versions-plugin');
+const lightCodeTheme = themes.github;
/** @type {import('@docusaurus/types').Config} */
const config = {
@@ -13,15 +14,18 @@ const config = {
onBrokenLinks: 'ignore',
onBrokenMarkdownLinks: 'ignore',
favicon: 'images/favicon.ico',
+ organizationName: 'Apache',
i18n: {
defaultLocale: 'en',
locales: ['en', 'zh-CN'],
localeConfigs: {
en: {
label: 'EN',
+ htmlLang: 'en-US',
},
'zh-CN': {
label: '中文',
+ htmlLang: 'zh-Hans-CN',
},
},
},
@@ -168,12 +172,12 @@ const config = {
({
announcementBar: {
id: 'support_us',
- content: `<a href="https://github.com/apache/doris" target="_blank" style="display: flex; width: 100%; align-items: center; justify-content: center; margin-left: 4px; text-decoration: none;">Do you like Apache Doris？Give us a 🌟 on Github
- <img style="width: 1.2rem; height: 1.2rem; margin-left: 0.4rem;" src="./images/github-white-icon.svg">
+ content: `<a href="https://github.com/apache/doris" target="_blank" style="display: flex; width: 100%; align-items: center; justify-content: center; margin-left: 4px; text-decoration: none; color: white">Do you like Apache Doris？Give us a 🌟 on Github
+ <img style="width: 1.2rem; height: 1.2rem; margin-left: 0.4rem;" src="/images/github-white-icon.svg">
</a>`,
backgroundColor: '#3C2FD4',
textColor: '#FFFFFF',
- isCloseable: false,
+ isCloseable: true,
},
navbar: {
title: '',
diff --git a/doris b/doris
new file mode 160000
index 00000000000..a68fc551f0c
--- /dev/null
+++ b/doris
@@ -0,0 +1 @@
+Subproject commit a68fc551f0cf6d7c3315a04703ed459dbb117877
diff --git a/package.json b/package.json
index 60fba9c3d42..8fee4059ae0 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
- "name": "selectdb-portal",
- "version": "1.0.0",
+ "name": "doris-website",
+ "version": "2.0.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
@@ -19,24 +19,24 @@
"typecheck": "tsc"
},
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.21",
- "@docusaurus/plugin-pwa": "2.0.0-beta.21",
- "@docusaurus/preset-classic": "2.0.0-beta.21",
- "@easyops-cn/docusaurus-search-local": "^0.30.2",
+ "@docusaurus/core": "^2.4.1",
+ "@docusaurus/plugin-pwa": "^2.4.1",
+ "@docusaurus/preset-classic": "^2.4.1",
+ "@easyops-cn/docusaurus-search-local": "^0.35.0",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.1.1",
- "docusaurus-plugin-sass": "^0.2.2",
- "prism-react-renderer": "^1.3.3",
+ "docusaurus-plugin-sass": "^0.2.3",
+ "prism-react-renderer": "^2.0.4",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-github-button": "^0.1.11",
- "sass": "^1.53.0",
+ "sass": "^1.63.2",
"swiper": "^9.0.5",
- "vitpress-generate-pdf": "^1.1.0"
+ "vitpress-generate-pdf": "^1.1.4"
},
"devDependencies": {
- "@docusaurus/module-type-aliases": "^2.0.0-beta.21",
- "@tsconfig/docusaurus": "^1.0.6",
+ "@docusaurus/module-type-aliases": "^2.4.1",
+ "@tsconfig/docusaurus": "^1.0.7",
"typescript": "^4.7.4"
},
"browserslist": {
diff --git a/prepare_local_dev.sh b/prepare_local_dev.sh
new file mode 100644
index 00000000000..5120e157dbc
--- /dev/null
+++ b/prepare_local_dev.sh
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+##############################################################
+# This is a native document format compilation check script
+##############################################################
+
+#!/bin/bash
+
+set -eo pipefail
+
+rm -rf doris
+git clone https://github.com/apache/doris.git --depth 1
+mkdir -p docs
+cp -R doris/docs/en/docs/* docs/
+cp -R doris/docs/sidebars.json sidebars.json
+rm -rf i18n/zh-CN/docusaurus-plugin-content-docs/current
+mkdir -p i18n/zh-CN/docusaurus-plugin-content-docs/current
+cp -R doris/docs/zh-CN/docs/* i18n/zh-CN/docusaurus-plugin-content-docs/current/
+rm -rf i18n/zh-CN/docusaurus-plugin-content-docs/current.json
+cp -R doris/docs/dev.json i18n/zh-CN/docusaurus-plugin-content-docs/current.json
+
+mkdir -p community
+cp -R doris/docs/en/community/* community/
+mkdir -p i18n/zh-CN/docusaurus-plugin-content-docs-community/current/
+cp -R doris/docs/zh-CN/community/* i18n/zh-CN/docusaurus-plugin-content-docs-community/current/
+cp -R doris/docs/sidebarsCommunity.json .
+
+cp -R doris/docs/images static/
\ No newline at end of file
diff --git a/src/pages/index.tsx b/src/pages/index.tsx
index 05134b4ddc4..30eb798edcc 100644
--- a/src/pages/index.tsx
+++ b/src/pages/index.tsx
@@ -144,7 +144,7 @@ export default function Home(): JSX.Element {
id: 'homepage.banner.subTitle',
message: 'An easy-to-use, high-performance and unified analytical database',
})}
- showAnnouncementBar
+ showAnnouncementBar={true}
>
<PageBanner {...banner}></PageBanner>
<section className="news-section">
diff --git a/src/theme/AnnouncementBar/index.tsx b/src/theme/AnnouncementBar/index.tsx
index e80abaa5742..40d6c4e1547 100644
--- a/src/theme/AnnouncementBar/index.tsx
+++ b/src/theme/AnnouncementBar/index.tsx
@@ -1,9 +1,10 @@
import React from 'react';
import clsx from 'clsx';
-import { useThemeConfig, useAnnouncementBar } from '@docusaurus/theme-common';
+import { useThemeConfig } from '@docusaurus/theme-common';
+import { useAnnouncementBar } from '@docusaurus/theme-common/internal';
import { translate } from '@docusaurus/Translate';
-import IconClose from '@theme/IconClose';
import styles from './styles.module.css';
+import IconClose from '@theme/Icon/Close';
export default function AnnouncementBar() {
const { isActive, close } = useAnnouncementBar();
const { announcementBar } = useThemeConfig();
diff --git a/src/theme/BlogLayout/style.scss b/src/theme/BlogLayout/style.scss
index ab8161b8123..ba78e8f16aa 100644
--- a/src/theme/BlogLayout/style.scss
+++ b/src/theme/BlogLayout/style.scss
@@ -1,5 +1,5 @@
.blog-container {
- margin-top: 0 !important;
+ // margin-top: 0 !important;
}
@media (max-width: 996px) {
diff --git a/src/theme/BlogPostItem/index.tsx b/src/theme/BlogPostItem/index.tsx
index cf784ee21f7..c188eee7027 100644
--- a/src/theme/BlogPostItem/index.tsx
+++ b/src/theme/BlogPostItem/index.tsx
@@ -4,6 +4,7 @@ import Link from '@docusaurus/Link';
import { useBaseUrlUtils } from '@docusaurus/useBaseUrl';
import { usePluralForm } from '@docusaurus/theme-common';
import { blogPostContainerID } from '@docusaurus/utils-common';
+import { useBlogPost } from '@docusaurus/theme-common/internal';
import MDXContent from '@theme/MDXContent';
import './styles.scss';
// Very simple pluralization: probably good enough for now
@@ -27,9 +28,10 @@ function useReadingTimePlural() {
}
export default function BlogPostItem(props) {
const { withBaseUrl } = useBaseUrlUtils();
- const { children, frontMatter, assets, metadata, truncated, isBlogPostPage = false } = props;
+ const { metadata, isBlogPostPage } = useBlogPost();
+ const { children, frontMatter, truncated = false } = props;
const { date, formattedDate, permalink, tags, readingTime, title, editUrl, authors } = metadata;
- const image = assets.image ?? frontMatter.image;
+ // const image = assets.image ?? frontMatter.image;
const truncatedPost = !isBlogPostPage && truncated;
const tagsExists = tags.length > 0;
const TitleHeading = isBlogPostPage ? 'h1' : 'h2';
@@ -82,7 +84,7 @@ export default function BlogPostItem(props) {
</div>
</header>
- {image && <meta itemProp="image" content={withBaseUrl(image, { absolute: true })} />}
+ {/* {image && <meta itemProp="image" content={withBaseUrl(image, { absolute: true })} />} */}
<div
// This ID is used for the feed generation to locate the main content
diff --git a/src/theme/Footer/Links/MultiColumn/index.tsx b/src/theme/Footer/Links/MultiColumn/index.tsx
index b39d7205caf..c54819656cc 100644
--- a/src/theme/Footer/Links/MultiColumn/index.tsx
+++ b/src/theme/Footer/Links/MultiColumn/index.tsx
@@ -2,7 +2,7 @@ import React from 'react';
import LinkItem from '@theme/Footer/LinkItem';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import Translate from '@docusaurus/Translate';
-import { useAlternatePageUtils } from '@docusaurus/theme-common';
+import { useAlternatePageUtils } from '@docusaurus/theme-common/internal';
import NavbarItem from '@theme/NavbarItem';
function ColumnLinkItem({ item }) {
diff --git a/src/theme/Layout/index.tsx b/src/theme/Layout/index.tsx
index 9a7bbe98b57..00f96b8b9d8 100644
--- a/src/theme/Layout/index.tsx
+++ b/src/theme/Layout/index.tsx
@@ -1,16 +1,17 @@
import React from 'react';
import clsx from 'clsx';
import ErrorBoundary from '@docusaurus/ErrorBoundary';
-import { PageMetadata, ThemeClassNames, useKeyboardNavigation } from '@docusaurus/theme-common';
+import { PageMetadata, ThemeClassNames } from '@docusaurus/theme-common';
+import { useKeyboardNavigation } from '@docusaurus/theme-common/internal';
import SkipToContent from '@theme/SkipToContent';
-import AnnouncementBar from '@theme/AnnouncementBar';
-import LayoutProviders from '@theme/LayoutProviders';
+import Layout from '@theme-original/Layout';
import ErrorPageContent from '@theme/ErrorPageContent';
import useScrollTop from '@site/src/hooks/scroll-top-hooks';
import './styles.scss';
-import Navbar from '@theme/Navbar';
-import Footer from '../Footer';
-export default function Layout(props) {
+import AnnouncementBar from '../AnnouncementBar';
+// import Navbar from '@theme/Navbar';
+// import Footer from '../Footer';
+export default function CustomLayout(props) {
const {
children,
noFooter,
@@ -25,17 +26,17 @@ export default function Layout(props) {
const { isTop } = useScrollTop(80);
return (
- <LayoutProviders>
+ <Layout>
<PageMetadata title={title} description={description} />
<SkipToContent />
- {showAnnouncementBar && <AnnouncementBar />}
- <Navbar />
+ {/* {showAnnouncementBar && <AnnouncementBar />} */}
+ {/* <Navbar /> */}
<div className={clsx(ThemeClassNames.wrapper.main, wrapperClassName, isPage ? 'has-margin' : '')}>
<ErrorBoundary fallback={params => <ErrorPageContent {...params} />}>{children}</ErrorBoundary>
</div>
- {!noFooter && <Footer />}
- </LayoutProviders>
+ {/* {!noFooter && <Footer />} */}
+ </Layout>
);
}
diff --git a/src/theme/Navbar/Content/index.tsx b/src/theme/Navbar/Content/index.tsx
index 31d6de2f2f7..51a157d01b7 100644
--- a/src/theme/Navbar/Content/index.tsx
+++ b/src/theme/Navbar/Content/index.tsx
@@ -1,83 +1,72 @@
-import React from "react";
-import {
- splitNavbarItems,
- useNavbarMobileSidebar,
- useThemeConfig,
-} from "@docusaurus/theme-common";
-import NavbarItem from "@theme/NavbarItem";
-import NavbarColorModeToggle from "@theme/Navbar/ColorModeToggle";
-import SearchBar from "@theme/SearchBar";
-import NavbarMobileSidebarToggle from "@theme/Navbar/MobileSidebar/Toggle";
-import NavbarLogo from "@theme/Navbar/Logo";
-import NavbarSearch from "@theme/Navbar/Search";
-import styles from "./styles.module.css";
-import Link from "@docusaurus/Link";
-import Translate from "@docusaurus/Translate";
-import GitHubButton from "react-github-button";
+import React from 'react';
+import { useThemeConfig } from '@docusaurus/theme-common';
+import { splitNavbarItems, useNavbarMobileSidebar } from '@docusaurus/theme-common/internal';
+import NavbarItem from '@theme/NavbarItem';
+import NavbarColorModeToggle from '@theme/Navbar/ColorModeToggle';
+import SearchBar from '@theme/SearchBar';
+import NavbarMobileSidebarToggle from '@theme/Navbar/MobileSidebar/Toggle';
+import NavbarLogo from '@theme/Navbar/Logo';
+import NavbarSearch from '@theme/Navbar/Search';
+import styles from './styles.module.css';
+import Link from '@docusaurus/Link';
+import Translate from '@docusaurus/Translate';
+import GitHubButton from 'react-github-button';
function useNavbarItems() {
- // TODO temporary casting until ThemeConfig type is improved
- return useThemeConfig().navbar.items;
+ // TODO temporary casting until ThemeConfig type is improved
+ return useThemeConfig().navbar.items;
}
function NavbarItems({ items }) {
- return (
- <>
- {items.map((item, i) => (
- <NavbarItem {...item} key={i} />
- ))}
- </>
- );
+ return (
+ <>
+ {items.map((item, i) => (
+ <NavbarItem {...item} key={i} />
+ ))}
+ </>
+ );
}
function NavbarContentLayout({ left, right }) {
- return (
- <div className="navbar__inner">
- <div className="navbar__items">{left}</div>
- <div className="navbar__items navbar__items--right">{right}</div>
- </div>
- );
+ return (
+ <div className="navbar__inner">
+ <div className="navbar__items">{left}</div>
+ <div className="navbar__items navbar__items--right">{right}</div>
+ </div>
+ );
}
export default function NavbarContent({ mobile }) {
- const mobileSidebar = useNavbarMobileSidebar();
- const items = useNavbarItems();
- const [leftItems, rightItems] = splitNavbarItems(items);
- const searchBarItem = items.find((item) => item.type === "search");
- return (
- <NavbarContentLayout
- left={
- // TODO stop hardcoding items?
- <>
- {!mobileSidebar.disabled && <NavbarMobileSidebarToggle />}
- <NavbarLogo />
- <NavbarItems items={leftItems} />
- </>
- }
- right={
- // TODO stop hardcoding items?
- // Ask the user to add the respective navbar items => more flexible
- <>
- <NavbarItems items={rightItems} />
- <NavbarColorModeToggle className={styles.colorModeToggle} />
- {!searchBarItem && (
- <NavbarSearch className="navbar-search">
- <SearchBar />
- </NavbarSearch>
- )}
- <span className="github-btn desktop header-right-button-github">
- <GitHubButton
- type="stargazers"
- size="large"
- namespace="apache"
- repo="doris"
- />
- </span>
+ const mobileSidebar = useNavbarMobileSidebar();
+ const items = useNavbarItems();
+ const [leftItems, rightItems] = splitNavbarItems(items);
+ const searchBarItem = items.find(item => item.type === 'search');
+ return (
+ <NavbarContentLayout
+ left={
+ // TODO stop hardcoding items?
+ <>
+ {!mobileSidebar.disabled && <NavbarMobileSidebarToggle />}
+ <NavbarLogo />
+ <NavbarItems items={leftItems} />
+ </>
+ }
+ right={
+ // TODO stop hardcoding items?
+ // Ask the user to add the respective navbar items => more flexible
+ <>
+ <NavbarItems items={rightItems} />
+ <NavbarColorModeToggle className={styles.colorModeToggle} />
+ {!searchBarItem && (
+ <NavbarSearch className="navbar-search">
+ <SearchBar />
+ </NavbarSearch>
+ )}
+ <span className="github-btn desktop header-right-button-github">
+ <GitHubButton type="stargazers" size="large" namespace="apache" repo="doris" />
+ </span>
- <Link
- className="header-right-button-primary navbar-download-desktop"
- to="/download"
- >
- <Translate id="navbar.download">Download</Translate>
- </Link>
- </>
- }
- />
- );
+ <Link className="header-right-button-primary navbar-download-desktop" to="/download">
+ <Translate id="navbar.download">Download</Translate>
+ </Link>
+ </>
+ }
+ />
+ );
}
diff --git a/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx b/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx
index 3bf5776c2ac..d46798af728 100644
--- a/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx
+++ b/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx
@@ -1,41 +1,29 @@
-import React from "react";
-import {
- useNavbarMobileSidebar,
- useThemeConfig,
-} from "@docusaurus/theme-common";
-import NavbarItem from "@theme/NavbarItem";
-import GitHubButton from "react-github-button";
+import React from 'react';
+import { useThemeConfig } from '@docusaurus/theme-common';
+import { splitNavbarItems, useNavbarMobileSidebar } from '@docusaurus/theme-common/internal';
+import NavbarItem from '@theme/NavbarItem';
+import GitHubButton from 'react-github-button';
function useNavbarItems() {
- // TODO temporary casting until ThemeConfig type is improved
- return useThemeConfig().navbar.items;
+ // TODO temporary casting until ThemeConfig type is improved
+ return useThemeConfig().navbar.items;
}
// The primary menu displays the navbar items
export default function NavbarMobilePrimaryMenu() {
- const mobileSidebar = useNavbarMobileSidebar();
- // TODO how can the order be defined for mobile?
- // Should we allow providing a different list of items?
- const items = useNavbarItems();
- return (
- <>
- <ul className="menu__list">
- {items.map((item, i) => (
- <NavbarItem
- mobile
- {...item}
- onClick={() => mobileSidebar.toggle()}
- key={i}
- />
- ))}
- </ul>
- <span className="github-btn-mobile">
- <GitHubButton
- type="stargazers"
- size="large"
- namespace="apache"
- repo="doris"
- />
- </span>
- </>
- );
+ const mobileSidebar = useNavbarMobileSidebar();
+ // TODO how can the order be defined for mobile?
+ // Should we allow providing a different list of items?
+ const items = useNavbarItems();
+ return (
+ <>
+ <ul className="menu__list">
+ {items.map((item, i) => (
+ <NavbarItem mobile {...item} onClick={() => mobileSidebar.toggle()} key={i} />
+ ))}
+ </ul>
+ <span className="github-btn-mobile">
+ <GitHubButton type="stargazers" size="large" namespace="apache" repo="doris" />
+ </span>
+ </>
+ );
}
diff --git a/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx b/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx
index 850eb6c05a7..7808a222975 100644
--- a/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx
+++ b/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx
@@ -1,9 +1,10 @@
import React from 'react';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import { useAlternatePageUtils } from '@docusaurus/theme-common';
+import { useAlternatePageUtils } from '@docusaurus/theme-common/internal';
import { translate } from '@docusaurus/Translate';
import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem';
-import IconLanguage from '@theme/IconLanguage';
+import IconLanguage from '@theme/Icon/Language';
+
import './styles.scss';
import NavbarItem from '@theme/NavbarItem';
export default function LocaleDropdownNavbarItem({ mobile, dropdownItemsBefore, dropdownItemsAfter, ...props }) {
diff --git a/static/images/running_profile.png b/static/images/running_profile.png
index c1f5d5eac99..2b834e7391e 100644
Binary files a/static/images/running_profile.png and b/static/images/running_profile.png differ
diff --git a/versions.json b/versions.json
index d66cea44c16..0cb3f2953b8 100644
--- a/versions.json
+++ b/versions.json
@@ -1,3 +1,4 @@
[
+ "current",
"1.2"
]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org