This is an automated email from the ASF dual-hosted git repository.
jeffreyh pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/develop by this push:
new f75d2c254f fix:style details (#1446)
f75d2c254f is described below
commit f75d2c254fe9d85a13853108fccafb18892ac1c6
Author: yangon <2689991...@qq.com>
AuthorDate: Wed Dec 4 16:30:14 2024 +0800
fix:style details (#1446)
Co-authored-by: liyang <liy...@selectdb.com>
---
check_move.py | 7 ++
.../{compilation-arm.md => compilation-arm.mdx} | 9 +-
.../{basic-concepts.md => basic-concepts.mdx} | 8 +-
docusaurus.config.js | 34 ++++++-
.../{compilation-arm.md => compilation-arm.mdx} | 10 +-
.../{basic-concepts.md => basic-concepts.mdx} | 8 +-
.../{compilation-arm.md => compilation-arm.mdx} | 8 +-
.../{compilation-arm.md => compilation-arm.mdx} | 8 +-
.../{basic-concepts.md => basic-concepts.mdx} | 8 +-
.../{compilation-arm.md => compilation-arm.mdx} | 8 +-
.../{basic-concepts.md => basic-concepts.mdx} | 8 +-
src/hooks/use-format-date.ts | 14 +++
src/scss/components/markdown.scss | 101 ++++++++++++++++++++-
src/scss/components/navbar.scss | 1 +
src/scss/components/sidebar.scss | 6 +-
src/scss/custom.scss | 4 +-
src/theme/BlogListItem/HeadItem/index.tsx | 8 +-
src/theme/BlogListItem/index.tsx | 5 +-
src/theme/BlogPostItem/Header/Info/index.tsx | 14 +--
src/theme/DocSidebarItem/Category/style.scss | 16 ++--
.../{compilation-arm.md => compilation-arm.mdx} | 8 +-
.../{basic-concepts.md => basic-concepts.mdx} | 8 +-
.../table-design/index/index-overview.md | 52 ++++++-----
.../table-design/index/inverted-index.md | 17 ++--
.../{compilation-arm.md => compilation-arm.mdx} | 10 +-
.../{basic-concepts.md => basic-concepts.mdx} | 8 +-
26 files changed, 263 insertions(+), 125 deletions(-)
diff --git a/check_move.py b/check_move.py
index 825a359ae3..435421b69b 100755
--- a/check_move.py
+++ b/check_move.py
@@ -56,6 +56,13 @@ def process_md_file(file_path):
full_path += ".md"
for [from_path, to_path] in move_pairs:
+ from_base, from_ext = os.path.splitext(from_path)
+ to_base, to_ext = os.path.splitext(to_path)
+ if (from_ext in [".md", ".mdx"] and to_ext in [".md",
".mdx"]) and (
+ from_base == to_base
+ ):
+ continue
+
# In md, the link relative path starts from the directory
where the document is located, not the document
relative_to_path = os.path.relpath(
to_path, os.path.dirname(file_path)
diff --git a/docs/install/source-install/compilation-arm.md
b/docs/install/source-install/compilation-arm.mdx
similarity index 99%
rename from docs/install/source-install/compilation-arm.md
rename to docs/install/source-install/compilation-arm.mdx
index 98fe83ffe8..7bba7f230c 100644
--- a/docs/install/source-install/compilation-arm.md
+++ b/docs/install/source-install/compilation-arm.mdx
@@ -5,8 +5,7 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+{/* 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
@@ -21,8 +20,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -520,7 +519,7 @@ If you still encounter problems when compiling or starting,
please consult the [
> fatal error: curl/curl.h: No such file or directory
>
- > 2 | #include <curl/curl.h>
+ > 2 | #include <curl/curl.h>
>
> compilation terminated.
>
diff --git a/docs/table-design/data-partitioning/basic-concepts.md
b/docs/table-design/data-partitioning/basic-concepts.mdx
similarity index 99%
rename from docs/table-design/data-partitioning/basic-concepts.md
rename to docs/table-design/data-partitioning/basic-concepts.mdx
index c60e613509..1e92d3f0c8 100644
--- a/docs/table-design/data-partitioning/basic-concepts.md
+++ b/docs/table-design/data-partitioning/basic-concepts.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git a/docusaurus.config.js b/docusaurus.config.js
index a5b59c05dd..94b5c46ed7 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -62,9 +62,37 @@ const config = {
},
},
scripts: ['/js/custom-script.js'],
+ headTags: [
+ {
+ tagName: 'link',
+ attributes: {
+ rel: 'preconnect',
+ href: 'https://fonts.googleapis.com',
+ },
+ },
+ {
+ tagName: 'link',
+ attributes: {
+ rel: 'preconnect',
+ href: 'https://fonts.gstatic.com',
+ crossorigin: 'anonymous',
+ },
+ },
+ {
+ tagName: 'link',
+ attributes: {
+ href:
'https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&family=Noto+Sans:ital,wght@0,100..900;1,100..900&display=swap',
+ rel: 'stylesheet',
+ },
+ },
+ ],
stylesheets: [
-
'https://cdn-font.hyperos.mi.com/font/css?family=MiSans:100,200,300,400,450,500,600,650,700,900:Chinese_Simplify,Latin&display=swap',
-
'https://cdn-font.hyperos.mi.com/font/css?family=MiSans_Latin:100,200,300,400,450,500,600,650,700,900:Latin&display=swap',
+ //
'https://cdn-font.hyperos.mi.com/font/css?family=MiSans:100,200,300,400,450,500,600,650,700,900:Chinese_Simplify,Latin&display=swap',
+ //
'https://cdn-font.hyperos.mi.com/font/css?family=MiSans_Latin:100,200,300,400,450,500,600,650,700,900:Latin&display=swap',
+ //
'https://fonts.googleapis.com/css2?family=Inter:wght@100;200;300;400;500;600;700;800;900&display=swap',
+ // 'https://fonts.googleapis.com',
+ // 'https://fonts.gstatic.com',
+ //
'https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&family=Noto+Sans:ital,wght@0,100..900;1,100..900&display=swap'
],
organizationName: 'apache/doris-website', // Usually your GitHub org/user
name.
projectName: 'apache/doris-website', // Usually your repo name.
@@ -201,7 +229,7 @@ const config = {
postsPerPage: 'ALL',
blogSidebarCount: 0,
showReadingTime: false,
- onUntruncatedBlogPosts: "ignore"
+ onUntruncatedBlogPosts: 'ignore',
},
theme: {
customCss: require.resolve('./src/scss/custom.scss'),
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/source-install/compilation-arm.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/source-install/compilation-arm.mdx
similarity index 99%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/current/install/source-install/compilation-arm.md
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/current/install/source-install/compilation-arm.mdx
index 4903049929..a6c7020ec9 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/source-install/compilation-arm.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/source-install/compilation-arm.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -525,7 +525,7 @@ export USE_UNWIND=OFF
> fatal error: curl/curl.h: No such file or directory
>
- > 2 | #include <curl/curl.h>
+ > 2 | #include <curl/curl.h>
>
> compilation terminated.
>
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/table-design/data-partitioning/basic-concepts.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/table-design/data-partitioning/basic-concepts.mdx
similarity index 99%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/current/table-design/data-partitioning/basic-concepts.md
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/current/table-design/data-partitioning/basic-concepts.mdx
index 502aa57221..0f7d5c3405 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/table-design/data-partitioning/basic-concepts.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/table-design/data-partitioning/basic-concepts.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/install/source-install/compilation-arm.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/install/source-install/compilation-arm.mdx
similarity index 98%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/install/source-install/compilation-arm.md
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/install/source-install/compilation-arm.mdx
index 0c9ad90ce8..f24eabfc1f 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/install/source-install/compilation-arm.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/install/source-install/compilation-arm.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/source-install/compilation-arm.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/source-install/compilation-arm.mdx
similarity index 98%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/source-install/compilation-arm.md
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/source-install/compilation-arm.mdx
index c563e576c7..2ce3ef7752 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/source-install/compilation-arm.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/source-install/compilation-arm.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/table-design/data-partitioning/basic-concepts.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/table-design/data-partitioning/basic-concepts.mdx
similarity index 99%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/table-design/data-partitioning/basic-concepts.md
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/table-design/data-partitioning/basic-concepts.mdx
index d839d48a2e..e0d3fddb82 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/table-design/data-partitioning/basic-concepts.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/table-design/data-partitioning/basic-concepts.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/source-install/compilation-arm.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/source-install/compilation-arm.mdx
similarity index 99%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/source-install/compilation-arm.md
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/source-install/compilation-arm.mdx
index 61a62e5915..84c8d88094 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/source-install/compilation-arm.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/source-install/compilation-arm.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/table-design/data-partitioning/basic-concepts.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/table-design/data-partitioning/basic-concepts.mdx
similarity index 99%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/table-design/data-partitioning/basic-concepts.md
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/table-design/data-partitioning/basic-concepts.mdx
index 24eec04022..1439958a29 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/table-design/data-partitioning/basic-concepts.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/table-design/data-partitioning/basic-concepts.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git a/src/hooks/use-format-date.ts b/src/hooks/use-format-date.ts
new file mode 100644
index 0000000000..72084c1bb1
--- /dev/null
+++ b/src/hooks/use-format-date.ts
@@ -0,0 +1,14 @@
+import { useDateTimeFormat } from '@docusaurus/theme-common/internal';
+
+export default function useFormatDate(date:string) {
+ const dateTimeFormat = useDateTimeFormat({
+ day: 'numeric',
+ month: 'long',
+ year: 'numeric',
+ timeZone: 'UTC',
+ });
+
+ const formatDate = (date: string) => dateTimeFormat.format(new Date(date));
+
+ return formatDate(date);
+}
diff --git a/src/scss/components/markdown.scss
b/src/scss/components/markdown.scss
index 27421976a1..3c53ccbaa1 100644
--- a/src/scss/components/markdown.scss
+++ b/src/scss/components/markdown.scss
@@ -6,6 +6,7 @@
--custom-leading: 1rem;
--custom-heading-rhythm-bottom: 1.25;
--custom-heading-rhythm-top: 2.5;
+ --custom-h2-rhythm-top: 1.25;
--custom-tabs-rhythm-top: 1.25;
--custom-list-rhythm-bottom: 0.625;
--custom-h4-rhythm-bottom: 2;
@@ -58,7 +59,7 @@
h2,
h3,
h4 {
- margin-bottom: calc(var(--custom-leading) *
var(--custom-heading-rhythm-bottom));
+ margin-bottom: calc(var(--custom-leading) *
var(--custom-heading-rhythm-bottom)) !important;
}
ol,
@@ -69,22 +70,64 @@
.theme-code-block,
table,
- .theme-admonition-tip,
+ .theme-admonition,
details,
img {
margin-bottom: calc(var(--custom-leading) *
var(--custom-other-rhythm-margin));
margin-top: calc(var(--custom-leading) *
var(--custom-other-rhythm-margin));
}
- .theme-admonition-tip {
+ details {
+ border: 1px solid #dfe5f0;
+ border-radius: 0.25rem;
+ padding: 0;
+ background-color: #ffffff;
+ box-shadow: none;
+ }
+
+ details > summary {
+ padding: 0.75rem 1.625rem 0.75rem 3.25rem;
+ border-top-left-radius: 0.25rem;
+ border-top-right-radius: 0.25rem;
+ background-color: #f7f9fe;
+ }
+
+ details > summary::before {
+ left: 1.625rem;
+ top: 1.225rem;
+ border-color: transparent transparent transparent #8592a6;
+ }
+
+ details > div {
+ padding-left: 1.625rem;
+ padding-right: 1.625rem;
+ border-top: 1px solid #dfe5f0;
+ }
+
+ details > div > div {
+ margin-top: 0.75rem;
+ padding-top: 0;
+ padding-bottom: 1.25rem;
+ border: none;
+ }
+
+ .theme-admonition {
padding: calc(var(--custom-leading) * 2);
}
- h2,
+ h2 {
+ margin-top: calc(var(--custom-leading) * var(--custom-h2-rhythm-top) *
2);
+ padding-top: calc(var(--custom-leading) * var(--custom-h2-rhythm-top));
+ border-top: 1px solid #e6e7e9;
+ }
+
h3 {
margin-top: calc(var(--custom-leading) *
var(--custom-heading-rhythm-top));
}
+ h1,
+ h2,
+ h3,
h4 {
margin-top: calc(var(--custom-leading) *
var(--custom-h4-rhythm-bottom));
}
@@ -159,12 +202,20 @@
ul,
ol {
- list-style-type: disc;
padding-left: 1.625rem;
}
+ ul {
+ list-style-type: disc;
+ }
+ ol {
+ list-style-type: decimal;
+ }
ul ul {
list-style-type: circle;
}
+ ol ol {
+ list-style-type: lower-alpha;
+ }
ul ul ul {
list-style-type: square;
}
@@ -174,6 +225,46 @@
ol ul ul {
list-style-type: square;
}
+
+ .tabs-container {
+ .tabs__item--active {
+ z-index: 999;
+ border: 1.2px solid #ccd4e2 !important;
+ border-bottom-color: #ffffff !important;
+ border-top-left-radius: 0.25rem;
+ border-top-right-radius: 0.25rem;
+ color: #444fd9 !important;
+ font-weight: 700;
+ }
+ .tabs__item {
+ border: 1px solid transparent;
+ margin-bottom: 0;
+ border-bottom: 1px;
+ font-size: 0.875rem;
+ height: 2.75rem;
+ padding-top: 0.75rem;
+ padding-bottom: 0.625rem;
+ margin-right: 0.25rem;
+ }
+ .tabs__item:hover {
+ border-radius: 0.25rem 0.25rem 0 0;
+ background-color: #edf2fa;
+ border: 1.2px solid var(---N5, #dfe5f0);
+ }
+ }
+ .tabs-container .tabs {
+ position: relative;
+ padding-left: 0 !important;
+ }
+ .tabs-container .tabs::before {
+ position: absolute;
+ right: 0;
+ left: 0;
+ content: '';
+ border-bottom: 1.2px solid #ccd4e2;
+ box-sizing: border-box;
+ bottom: 0;
+ }
}
.theme-doc-markdown {
diff --git a/src/scss/components/navbar.scss b/src/scss/components/navbar.scss
index 42924464ec..d1d550013a 100644
--- a/src/scss/components/navbar.scss
+++ b/src/scss/components/navbar.scss
@@ -20,6 +20,7 @@
transform: translateX(-50%);
width: 38vw;
top: 12px;
+ max-width: 443px;
.navbar__search > :last-child {
position: absolute;
diff --git a/src/scss/components/sidebar.scss b/src/scss/components/sidebar.scss
index 608249ea7b..6e21f5e703 100644
--- a/src/scss/components/sidebar.scss
+++ b/src/scss/components/sidebar.scss
@@ -21,7 +21,7 @@
.theme-doc-sidebar-menu {
padding: 0.5rem;
-
+
.menu__list-item {
.menu__link {
font-size: var(--global-font-size-medium);
@@ -40,7 +40,9 @@
}
}
}
-
+ .menu__link--sublist-caret{
+ color: #1F1F26 !important;
+ }
.menu__list-item-collapsible {
.menu__link--sublist-caret {
diff --git a/src/scss/custom.scss b/src/scss/custom.scss
index 4fe89aae35..81686b7839 100644
--- a/src/scss/custom.scss
+++ b/src/scss/custom.scss
@@ -39,8 +39,8 @@
}
html[lang='zh-Hans-CN'] {
- --font-family-base: 'MiSans';
- font-family: 'MiSans', 'Source Sans Pro', 'Helvetica Neue', Helvetica,
Arial, sans-serif;
+ --font-family-base: 'Noto Sans';
+ font-family: 'Noto Sans', 'Source Sans Pro', 'Helvetica Neue', Helvetica,
Arial, sans-serif;
}
html[lang='en-US'] {
diff --git a/src/theme/BlogListItem/HeadItem/index.tsx
b/src/theme/BlogListItem/HeadItem/index.tsx
index b6547f8de2..446b8af07e 100644
--- a/src/theme/BlogListItem/HeadItem/index.tsx
+++ b/src/theme/BlogListItem/HeadItem/index.tsx
@@ -1,5 +1,6 @@
import Link from '@docusaurus/Link';
import React from 'react';
+import useFormatDate from '@site/src/hooks/use-format-date';
export default function HeadItem(props: any) {
const {
@@ -8,7 +9,6 @@ export default function HeadItem(props: any) {
image,
title,
summary,
- formattedDate,
date,
authorsExists,
authors,
@@ -30,7 +30,7 @@ export default function HeadItem(props: any) {
</div>
<div className="mt-4 flex justify-start space-x-2
text-sm leading-[1.375rem] text-[#8592a6]">
<time dateTime={date} itemProp="datePublished"
className="mr-4">
- {formattedDate}
+ {useFormatDate(date)}
</time>
{authorsExists && (
<>
@@ -62,7 +62,7 @@ export default function HeadItem(props: any) {
src={image}
alt=""
/>
- <div className="rounded-b-lg border border-t-0 border-[#DFE5F0]
group-hover:border-[#0065FD] h-full flex flex-col-reverse justify-between
lg:flex-row lg:py-0 py-6 lg:space-x-10 px-6">
+ <div className="rounded-b-lg border border-t-0 border-[#DFE5F0]
group-hover:border-[#0065FD] h-full flex flex-col-reverse justify-between
lg:flex-row lg:py-0 py-6 lg:pb-5 lg:space-x-10 px-6">
<div className="flex-1">
<h1 className=" mt-4 line-clamp-2 text-2xl font-medium
text-black-dark lg:text-[2rem] lg:leading-[3rem]">
{title}
@@ -75,7 +75,7 @@ export default function HeadItem(props: any) {
<div className="mt-4 flex space-x-6">
<span className="text-sm text-[#8592a6]">
<time dateTime={date} itemProp="datePublished"
className="mr-4">
- {formattedDate}
+ {useFormatDate(date)}
</time>
{authorsExists && (
<>
diff --git a/src/theme/BlogListItem/index.tsx b/src/theme/BlogListItem/index.tsx
index b1946b0a5b..f5660e1021 100644
--- a/src/theme/BlogListItem/index.tsx
+++ b/src/theme/BlogListItem/index.tsx
@@ -9,6 +9,7 @@ import MDXContent from '@theme/MDXContent';
import EditThisPage from '@theme/EditThisPage';
import TagsListInline from '@theme/TagsListInline';
import BlogPostAuthors from '@theme/BlogPostAuthors';
+import useFormatDate from '@site/src/hooks/use-format-date';
import './styles.scss';
import HeadItem from './HeadItem';
// Very simple pluralization: probably good enough for now
@@ -34,7 +35,7 @@ export default function BlogListItem(props) {
const readingTimePlural = useReadingTimePlural();
const { withBaseUrl } = useBaseUrlUtils();
const { children, frontMatter, assets, metadata, large = false } = props;
- const { date, formattedDate, permalink, tags, readingTime, title, editUrl,
authors } = metadata;
+ const { date, permalink, tags, readingTime, title, editUrl, authors } =
metadata;
const image = assets.image ?? frontMatter.image;
const tagsExists = tags.length > 0;
const summary = frontMatter.summary;
@@ -110,7 +111,7 @@ export default function BlogListItem(props) {
} justify-start space-x-2 text-sm leading-[1.375rem]
text-[#8592a6]`}
>
<time dateTime={date} itemProp="datePublished">
- {formattedDate}
+ {useFormatDate(date)}
</time>
{authorsExists && (
diff --git a/src/theme/BlogPostItem/Header/Info/index.tsx
b/src/theme/BlogPostItem/Header/Info/index.tsx
index 930fcd4835..857fde62ea 100644
--- a/src/theme/BlogPostItem/Header/Info/index.tsx
+++ b/src/theme/BlogPostItem/Header/Info/index.tsx
@@ -2,9 +2,9 @@ import React from 'react';
import clsx from 'clsx';
import { translate } from '@docusaurus/Translate';
import { usePluralForm } from '@docusaurus/theme-common';
-import { useDateTimeFormat } from '@docusaurus/theme-common/internal';
import { useBlogPost } from '@docusaurus/plugin-content-blog/client';
import type { Props } from '@theme/BlogPostItem/Header/Info';
+import useFormatDate from '@site/src/hooks/use-format-date'
// Very simple pluralization: probably good enough for now
function useReadingTimePlural() {
@@ -34,20 +34,12 @@ function DateTime({ date, formattedDate }: { date: string;
formattedDate: string
);
}
+
export default function BlogPostItemHeaderInfo({ className }: Props):
JSX.Element {
const { metadata } = useBlogPost();
const { date, readingTime, authors } = metadata;
- const formatDate = (blogDate: string) => dateTimeFormat.format(new
Date(blogDate));
-
- const dateTimeFormat = useDateTimeFormat({
- day: 'numeric',
- month: 'long',
- year: 'numeric',
- timeZone: 'UTC',
- });
-
const authorsExists = authors && authors.length > 0;
return (
<div className="blog-info text-center flex justify-center text-sm
text-black">
@@ -62,7 +54,7 @@ export default function BlogPostItemHeaderInfo({ className }:
Props): JSX.Elemen
</span>
</>
)}
- <DateTime date={date} formattedDate={formatDate(date)} />
+ <DateTime date={date} formattedDate={useFormatDate(date)} />
</div>
);
}
diff --git a/src/theme/DocSidebarItem/Category/style.scss
b/src/theme/DocSidebarItem/Category/style.scss
index ca974f2b6a..c642c4779f 100644
--- a/src/theme/DocSidebarItem/Category/style.scss
+++ b/src/theme/DocSidebarItem/Category/style.scss
@@ -1,13 +1,5 @@
.theme-doc-sidebar-menu.menu__list {
padding-left: 1rem;
- .menu__link_level_2.menu__link {
- color: #1d1d1d !important;
- }
- .theme-doc-sidebar-item-link-level-2 {
- .menu__link {
- color: #1d1d1d !important;
- }
- }
.menu__link.menu__link--active:not(.menu__link--sublist) {
color: #444fd9 !important;
font-weight: 500;
@@ -17,6 +9,7 @@
a.menu__link {
line-height: 2rem;
padding: 0 0.625rem;
+ color: #1d1d1d !important;
// color: #4c576c;
// font-size: 14px;
font-weight: 400;
@@ -39,7 +32,6 @@
.title_level_1 {
color: #00000a;
text-align: center;
- font-family: Inter;
font-size: 14px;
font-style: normal;
font-weight: 600;
@@ -55,6 +47,10 @@
.menu__list_level_2 {
padding-left: 0 !important;
+ margin-top: 0 !important;
+ }
+ .community_level_2 {
+ padding-left: 0.75rem !important;
}
.community_level_2 {
padding-left: 0.75rem !important;
@@ -63,7 +59,7 @@
.divider {
width: calc(100% - 0.625rem);
border: 0.5px solid #edf2fa;
- margin: 0.625rem 0 1rem 0;
+ margin: 1rem 0 1rem 0;
position: relative;
left: 0.625rem;
}
diff --git
a/versioned_docs/version-2.0/install/source-install/compilation-arm.md
b/versioned_docs/version-2.0/install/source-install/compilation-arm.mdx
similarity index 99%
rename from versioned_docs/version-2.0/install/source-install/compilation-arm.md
rename to versioned_docs/version-2.0/install/source-install/compilation-arm.mdx
index cb6840181a..b9bf9506d6 100644
--- a/versioned_docs/version-2.0/install/source-install/compilation-arm.md
+++ b/versioned_docs/version-2.0/install/source-install/compilation-arm.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git
a/versioned_docs/version-2.1/table-design/data-partitioning/basic-concepts.md
b/versioned_docs/version-2.1/table-design/data-partitioning/basic-concepts.mdx
similarity index 99%
rename from
versioned_docs/version-2.1/table-design/data-partitioning/basic-concepts.md
rename to
versioned_docs/version-2.1/table-design/data-partitioning/basic-concepts.mdx
index f701a9db97..101071cb2f 100644
---
a/versioned_docs/version-2.1/table-design/data-partitioning/basic-concepts.md
+++
b/versioned_docs/version-2.1/table-design/data-partitioning/basic-concepts.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git a/versioned_docs/version-2.1/table-design/index/index-overview.md
b/versioned_docs/version-2.1/table-design/index/index-overview.md
index 81a1469f15..be2f718572 100644
--- a/versioned_docs/version-2.1/table-design/index/index-overview.md
+++ b/versioned_docs/version-2.1/table-design/index/index-overview.md
@@ -30,48 +30,58 @@ Database indexes are used to accelerate queries. To speed
up different query sce
From the perspective of accelerating queries and their principles, Doris
indexes are categorized into two main types: point query indexes and skip
indexes.
- **Point Query Indexes:** Commonly used to speed up point queries, the
principle is to locate which rows satisfy the WHERE conditions through the
index and directly read those rows. Point query indexes are very effective when
the number of rows meeting the conditions is small. Doris's point query indexes
include Prefix Index and Inverted Index.
+
- **Prefix Index:** Doris stores data in an ordered manner according to the
sort key and creates a sparse prefix index every 1024 rows. The key in the
index is the value of the sorted column in the first row of the current 1024
rows. If the query involves a sorted column, the system will find the first row
of the relevant 1024-row group and start scanning from there.
+
- **Inverted Index:** For columns with an inverted index, an posting list is
created mapping each value to a set of row ids. For equality queries, it first
finds the set of row ids from the posting list, then directly reads the data of
those rows, avoiding row-by-row scanning. Inverted indexes can also accelerate
range filtering and fulltext search. The algorithms are more complex, but the
basic principles are similar. (Note: the previous BITMAP index has been
replaced by the more powe [...]
+
- **Skip Indexes:** Commonly used to accelerate analysis, the principle is to
determine data blocks that do not satisfy the WHERE conditions through the
index and skip these blocks, only reading the data blocks that may satisfy the
conditions and then performing a row-by-row filter to finally get the rows that
meet the conditions. Skip indexes are more effective when the number of rows
meeting the conditions is large. Doris's skip indexes include ZoneMap indexes,
BloomFilter indexes, and [...]
+
- **ZoneMap Index:** Automatically maintains statistics for each column,
recording the maximum, minimum, and whether there are NULL values for each data
file (Segment) and data block (Page). For equality queries, range queries, and
IS NULL, it can determine whether the data file and data block can contain the
data that meets the conditions based on the maximum value, minimum value, and
whether there are NULL values. If not, Doris skips reading the corresponding
file or data block, redu [...]
+
- **BloomFilter Index:** Stores values of the indexed column in a
BloomFilter data structure, which can quickly determine whether a value is in
the BloomFilter with very low storage space. For equality queries, if the value
is not in the BloomFilter, the corresponding data file or data block can be
skipped, reducing IO and accelerating queries.
+
- **NGram BloomFilter Index:** Used to accelerate text LIKE queries. The
principle is similar to the BloomFilter index, but instead of storing the
original text values, it performs NGram tokenization of the text and stores
each token in the BloomFilter. For LIKE queries, the LIKE pattern is also
tokenized using NGram. If any token is not in the BloomFilter, the
corresponding data file or data block does not meet the LIKE condition and can
be skipped.
Among the above indexes, the prefix index and ZoneMap index are built-in
indexes automatically maintained by Doris, requiring no user management.
Inverted indexes, BloomFilter indexes, and NGram BloomFilter indexes need to be
manually created and managed by the user based on the scenario.
- Comparison of characteristics of different types of indexes
-| Type | Index | Advantages
| Limitations
|
-|------------|-------------------|---------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
-| Point Query| Prefix Index | Built-in index, best performance.<br />Only
one prefix index per table. | Only one prefix index per table.
|
-| Point Query| Inverted Index | Supports tokenization and keyword
matching.<br />Building index on any column.<br />Multi-condition combination
and accelerating more functions. | Large index storage space, similar to raw
data. |
-| Skip | ZoneMap Index | Built-in index, small index storage
space.<br />Only one prefix index per table. | Only one prefix index per
table.
|
-| Skip | BloomFilter Index | More precise than ZoneMap, medium index
space. | Supports few query types.<br />Only
supports equal (not others: not equal, range, LIKE, MATCH).
|
-| Skip | NGram BloomFilter | Supports LIKE acceleration, medium index
space. | Supports few query types.<br />Only
supports LIKE acceleration.
|
+ | Type | Index | Advantages
| Limitations
|
+
|------------|-------------------|---------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
+ | Point Query| Prefix Index | Built-in index, best performance.<br
/>Only one prefix index per table. | Only one prefix index per
table.
|
+ | Point Query| Inverted Index | Supports tokenization and keyword
matching.<br />Building index on any column.<br />Multi-condition combination
and accelerating more functions. | Large index storage space, similar to raw
data. |
+ | Skip | ZoneMap Index | Built-in index, small index storage
space.<br />Only one prefix index per table. | Only one prefix index per
table.
|
+ | Skip | BloomFilter Index | More precise than ZoneMap, medium index
space. | Supports few query types.<br />Only
supports equal (not others: not equal, range, LIKE, MATCH).
|
+ | Skip | NGram BloomFilter | Supports LIKE acceleration, medium index
space. | Supports few query types.<br />Only
supports LIKE acceleration.
|
- List of operators and functions for index acceleration
-| Operator or Function | Prefix Index | Inverted Index | ZoneMap Index |
BloomFilter Index | NGram BloomFilter Index |
-|-------------------------|---------|---------|--------------|-----------------|------------------------|
-| = | YES | YES | YES | YES
| NO |
-| != | YES | YES | NO | NO
| NO |
-| IN | YES | YES | YES | YES
| NO |
-| NOT IN | YES | YES | NO | NO
| NO |
-| >, >=, <, <=, BETWEEN | YES | YES | YES | NO
| NO |
-| IS NULL | YES | YES | YES | NO
| NO |
-| IS NOT NULL | YES | YES | NO | NO
| NO |
-| LIKE | NO | NO | NO | NO
| YES |
-| MATCH, MATCH_* | NO | YES | NO | NO
| NO |
-| array_contains | NO | YES | NO | NO
| NO |
-| array_overlaps | NO | YES | NO | NO
| NO |
-| is_ip_address_in_range | NO | YES | NO | NO
| NO |
+ | Operator or Function | Prefix Index | Inverted Index | ZoneMap Index |
BloomFilter Index | NGram BloomFilter Index |
+
|-------------------------|---------|---------|--------------|-----------------|------------------------|
+ | = | YES | YES | YES | YES
| NO |
+ | != | YES | YES | NO | NO
| NO |
+ | IN | YES | YES | YES | YES
| NO |
+ | NOT IN | YES | YES | NO | NO
| NO |
+ | >, >=, <, <=, BETWEEN | YES | YES | YES | NO
| NO |
+ | IS NULL | YES | YES | YES | NO
| NO |
+ | IS NOT NULL | YES | YES | NO | NO
| NO |
+ | LIKE | NO | NO | NO | NO
| YES |
+ | MATCH, MATCH_* | NO | YES | NO | NO
| NO |
+ | array_contains | NO | YES | NO | NO
| NO |
+ | array_overlaps | NO | YES | NO | NO
| NO |
+ | is_ip_address_in_range | NO | YES | NO | NO
| NO |
## Index Design Guidelines
The design and optimization of database table indexes are closely related to
data distribution and queries, requiring testing and optimization based on the
actual scenario. Although there is no "silver bullet," Doris continuously
strives to reduce the difficulty of using indexes. Users can follow these
simple guidelines for index selection and testing.
1. Specify the most frequently used filter condition as the KEY to
automatically create a prefix index, as it has the best filtering effect.
However, only one prefix index can be created per table, so it should be used
for the most frequent filter condition.
+
2. For non-key fields that require filter acceleration, the first choice is to
create an inverted index due to its broad applicability and multi-condition
combination. The second choice includes the following two indexes:
+
- If there is a need for string LIKE matching, add an NGram BloomFilter
index.
+
- If index storage space is critical, replace the inverted index with a
BloomFilter index.
+
3. If performance is not as expected, analyze the amount of data filtered by
the index and the time consumed through QueryProfile. Refer to the detailed
documentation of each index for specifics.
\ No newline at end of file
diff --git a/versioned_docs/version-2.1/table-design/index/inverted-index.md
b/versioned_docs/version-2.1/table-design/index/inverted-index.md
index 68061d2583..32f657803a 100644
--- a/versioned_docs/version-2.1/table-design/index/inverted-index.md
+++ b/versioned_docs/version-2.1/table-design/index/inverted-index.md
@@ -41,17 +41,14 @@ Inverted indexes have a wide range of applications and can
accelerate equality,
The functionality of inverted indexes is briefly introduced as follows:
-**1. Accelerate full-text searches for string types**
-
-- Support for keyword search, including matching multiple keywords
simultaneously `MATCH_ALL` and matching any one keyword `MATCH_ANY`.
-
-- Support for phrase queries `MATCH_PHRASE`
- - Support for specifying slop for word distence
- - Support for phrase + prefix `MATCH_PHRASE_PREFIX`
+**1. Accelerate full-text searches for string types**
+ - Support for keyword search, including matching multiple keywords
simultaneously `MATCH_ALL` and matching any one keyword `MATCH_ANY`.
+
+ - Support for phrase queries `MATCH_PHRASE`
-- Support for tokenized regular expression queries `MATCH_REGEXP`
+ - Support for tokenized regular expression queries `MATCH_REGEXP`
-- Support for English, Chinese, and Unicode tokenizers
+ - Support for English, Chinese, and Unicode tokenizers
**2. Accelerate normal equality and range queries, covering and replacing the
functionality of BITMAP index**
@@ -166,7 +163,7 @@ Syntax explanation:
```sql
INDEX idx_name(column_name) USING INVERTED PROPERTIES("parser" = "unicode",
"char_filter_type" = "char_replace", "char_filter_pattern" = "._",
"char_filter_replacement" = " ")
```
-`
+
</details>
<details>
diff --git
a/versioned_docs/version-3.0/install/source-install/compilation-arm.md
b/versioned_docs/version-3.0/install/source-install/compilation-arm.mdx
similarity index 99%
rename from versioned_docs/version-3.0/install/source-install/compilation-arm.md
rename to versioned_docs/version-3.0/install/source-install/compilation-arm.mdx
index 98fe83ffe8..4d72e347a2 100644
--- a/versioned_docs/version-3.0/install/source-install/compilation-arm.md
+++ b/versioned_docs/version-3.0/install/source-install/compilation-arm.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -520,7 +520,7 @@ If you still encounter problems when compiling or starting,
please consult the [
> fatal error: curl/curl.h: No such file or directory
>
- > 2 | #include <curl/curl.h>
+ > 2 | #include <curl/curl.h>
>
> compilation terminated.
>
diff --git
a/versioned_docs/version-3.0/table-design/data-partitioning/basic-concepts.md
b/versioned_docs/version-3.0/table-design/data-partitioning/basic-concepts.mdx
similarity index 99%
rename from
versioned_docs/version-3.0/table-design/data-partitioning/basic-concepts.md
rename to
versioned_docs/version-3.0/table-design/data-partitioning/basic-concepts.mdx
index 7b00aebcc0..7313e247e8 100644
---
a/versioned_docs/version-3.0/table-design/data-partitioning/basic-concepts.md
+++
b/versioned_docs/version-3.0/table-design/data-partitioning/basic-concepts.mdx
@@ -5,8 +5,8 @@
}
---
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
+
+{/* 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
@@ -21,8 +21,8 @@ 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.
--->
+under the License. */}
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
