From 1f3f99ef296a039eec6a218cfd30cf9808d62c1d Mon Sep 17 00:00:00 2001 From: arvinxx Date: Fri, 24 Nov 2023 00:14:15 +0800 Subject: [PATCH] :memo: docs: fix docs --- docs/api/create-instance.en-US.md | 3 +++ docs/api/create-instance.zh-CN.md | 3 +++ docs/api/create-styles.en-US.md | 4 +--- docs/api/create-styles.zh-CN.md | 4 +--- docs/api/global-styles.en-US.md | 2 +- docs/api/use-theme.en-US.md | 1 - docs/api/use-theme.zh-CN.md | 1 - docs/best-practice/antd-based-components.en-US.md | 4 +--- docs/best-practice/index.en-US.md | 2 -- docs/best-practice/mac-select.en-US.md | 2 +- .../mirgration-less-global-style.en-US.md | 2 +- docs/best-practice/nest-element-style.en-US.md | 2 +- docs/guide/compare.en-US.md | 2 -- docs/guide/css-in-js-intro.en-US.md | 2 +- docs/guide/migrate-less-codemod.en-US.md | 2 +- docs/{index.en-US.md => index.md} | 13 ++++++------- 16 files changed, 21 insertions(+), 28 deletions(-) rename docs/{index.en-US.md => index.md} (99%) diff --git a/docs/api/create-instance.en-US.md b/docs/api/create-instance.en-US.md index 32234e5d..4bbf8352 100644 --- a/docs/api/create-instance.en-US.md +++ b/docs/api/create-instance.en-US.md @@ -5,6 +5,9 @@ sourceUrl: '{github}/blob/master/src/functions/createInstance.ts' group: title: Advanced Settings order: 10 +nav: + title: API Reference + order: 10 --- ## Introduction diff --git a/docs/api/create-instance.zh-CN.md b/docs/api/create-instance.zh-CN.md index 903fb6cf..1edc14ae 100644 --- a/docs/api/create-instance.zh-CN.md +++ b/docs/api/create-instance.zh-CN.md @@ -5,6 +5,9 @@ sourceUrl: '{github}/blob/master/src/functions/createInstance.ts' group: title: 高级设置 order: 10 +nav: + title: API + order: 10 --- ## 简介 diff --git a/docs/api/create-styles.en-US.md b/docs/api/create-styles.en-US.md index 0323d96d..69e3d2c9 100644 --- a/docs/api/create-styles.en-US.md +++ b/docs/api/create-styles.en-US.md @@ -3,9 +3,7 @@ title: createStyles description: Create scoped styles order: 0 sourceUrl: '{github}/blob/master/src/factories/createStyles/index.ts' -group: - title: Style Creation - order: 0 +group: Creating Styles demo: tocDepth: 4 --- diff --git a/docs/api/create-styles.zh-CN.md b/docs/api/create-styles.zh-CN.md index f9a7706b..758b7253 100644 --- a/docs/api/create-styles.zh-CN.md +++ b/docs/api/create-styles.zh-CN.md @@ -3,9 +3,7 @@ title: createStyles description: 创建具有作用域的样式 order: 0 sourceUrl: '{github}/blob/master/src/factories/createStyles/index.ts' -group: - title: 创建样式 - order: 0 +group: 创建样式 demo: tocDepth: 4 --- diff --git a/docs/api/global-styles.en-US.md b/docs/api/global-styles.en-US.md index 4b8b4ebf..30cda7fb 100644 --- a/docs/api/global-styles.en-US.md +++ b/docs/api/global-styles.en-US.md @@ -2,7 +2,7 @@ title: createGlobalStyle description: Create global styles order: 10 -group: Style Creation +group: Creating Styles --- ## Introduction diff --git a/docs/api/use-theme.en-US.md b/docs/api/use-theme.en-US.md index dbaee049..3f6dae46 100644 --- a/docs/api/use-theme.en-US.md +++ b/docs/api/use-theme.en-US.md @@ -1,7 +1,6 @@ --- title: useTheme order: 1 -nav: API group: Hooks --- diff --git a/docs/api/use-theme.zh-CN.md b/docs/api/use-theme.zh-CN.md index 3bf3744c..36797cb3 100644 --- a/docs/api/use-theme.zh-CN.md +++ b/docs/api/use-theme.zh-CN.md @@ -1,7 +1,6 @@ --- title: useTheme order: 1 -nav: API group: Hooks --- diff --git a/docs/best-practice/antd-based-components.en-US.md b/docs/best-practice/antd-based-components.en-US.md index fc92af38..5484b73a 100644 --- a/docs/best-practice/antd-based-components.en-US.md +++ b/docs/best-practice/antd-based-components.en-US.md @@ -1,10 +1,8 @@ -```markdown --- title: 🚧 Styling Best Practices for Customizing Components Based on antd v5 group: - title: Component Library Development + title: UI Library Development order: 3 --- # How to Write Styles Elegantly for a Component Library Based on antd v5? -``` diff --git a/docs/best-practice/index.en-US.md b/docs/best-practice/index.en-US.md index 1e0f863d..80393d65 100644 --- a/docs/best-practice/index.en-US.md +++ b/docs/best-practice/index.en-US.md @@ -1,4 +1,3 @@ -```markdown --- title: Best Practices and Case Studies nav: @@ -13,4 +12,3 @@ As more and more users adopt antd-style, it has been observed that users still e Therefore, this section has been adjusted to focus on "Best Practices" and "Case Studies", detailing the best practices for using antd-style based on common scenarios encountered by users. In addition to best practices, this section also includes some practical case studies, with the hope of providing assistance to you. -``` diff --git a/docs/best-practice/mac-select.en-US.md b/docs/best-practice/mac-select.en-US.md index 138dc4d8..609f2dc4 100644 --- a/docs/best-practice/mac-select.en-US.md +++ b/docs/best-practice/mac-select.en-US.md @@ -1,5 +1,5 @@ --- -title: Custom Component: MacOS Selector +title: Custom Component —— macOS Selector group: title: Style Cases order: 10 diff --git a/docs/best-practice/mirgration-less-global-style.en-US.md b/docs/best-practice/mirgration-less-global-style.en-US.md index ce798bd7..54101df3 100644 --- a/docs/best-practice/mirgration-less-global-style.en-US.md +++ b/docs/best-practice/mirgration-less-global-style.en-US.md @@ -1,7 +1,7 @@ --- title: CSS Modules Global Style Override Migration group: - title: Style Writing + title: Writing Style order: 0 --- diff --git a/docs/best-practice/nest-element-style.en-US.md b/docs/best-practice/nest-element-style.en-US.md index f4daaa6b..95550c6f 100644 --- a/docs/best-practice/nest-element-style.en-US.md +++ b/docs/best-practice/nest-element-style.en-US.md @@ -1,6 +1,6 @@ --- title: Writing Linked Styles for Parent-Child Components -group: Style Writing +group: Writing Style --- # How to Write Linked Styles diff --git a/docs/guide/compare.en-US.md b/docs/guide/compare.en-US.md index e9612172..7096bdf3 100644 --- a/docs/guide/compare.en-US.md +++ b/docs/guide/compare.en-US.md @@ -1,4 +1,3 @@ -````markdown --- title: Comparison of CSS in JS Writing Methods order: 2 @@ -25,7 +24,6 @@ Most applications using antd are generally paired with less and css modules for box-shadow: 0 8px 20px @shadow-color; } ``` -```` ```tsx | pure // index.tsx diff --git a/docs/guide/css-in-js-intro.en-US.md b/docs/guide/css-in-js-intro.en-US.md index 91b4ad75..55d0cc22 100644 --- a/docs/guide/css-in-js-intro.en-US.md +++ b/docs/guide/css-in-js-intro.en-US.md @@ -1,7 +1,7 @@ --- title: Quick Start to CSS in JS order: 1 -group: Fundamentals +group: Basic Knowledge --- # Quick Start to CSS in JS diff --git a/docs/guide/migrate-less-codemod.en-US.md b/docs/guide/migrate-less-codemod.en-US.md index 4e03f933..3843b28d 100644 --- a/docs/guide/migrate-less-codemod.en-US.md +++ b/docs/guide/migrate-less-codemod.en-US.md @@ -1,8 +1,8 @@ --- - title: Less Application Automated Migration order: 0 group: Migrating from Less +--- # Migrate Less Applications with Codemod diff --git a/docs/index.en-US.md b/docs/index.md similarity index 99% rename from docs/index.en-US.md rename to docs/index.md index ff5cd9df..ee359880 100644 --- a/docs/index.en-US.md +++ b/docs/index.md @@ -1,4 +1,3 @@ -```markdown --- hero: title: Ant Design Style @@ -15,13 +14,13 @@ features: description: Ant Design Style is compatible with various style engines such as styled-components, emotion-styled, etc., and has rich writing capabilities. link: /guide/strategy imageType: light - row: 8 - title: One-click Dark Mode Switch link: /guide/switch-theme description: We have encapsulated dynamic theme configuration and dark theme algorithm based on antd v5 cssinjs, providing easy-to-use light and dark theme switching capabilities for application-level scenarios, making it easier to use. image: https://mdn.alipayobjects.com/huamei_rqvucu/afts/img/A*8KE7T7l39J0AAAAAAAAAAAAADoN6AQ/original imageType: primary + row: 8 - title: Flexible Theme Extension description: Ant Design Style provides custom token and stylish functionality. When the default antd token does not meet the styling requirements, you can flexibly extend your own theme system and freely consume it in CSS in JS. @@ -43,30 +42,30 @@ features: link: /guide/stylish image: https://mdn.alipayobjects.com/huamei_rqvucu/afts/img/A*_in2RLf5pY8AAAAAAAAAAAAADoN6AQ/original imageType: primary - row: 9 + row: 10 - title: Smooth Migration from less description: Need to migrate from an old project? Using antd-style can smoothly migrate less in the project to CSS in JS at a lower cost, and provide a better user experience and development experience. link: /guide/migrate-from-less image: https://mdn.alipayobjects.com/huamei_rqvucu/afts/img/A*5H2ySLO-X4cAAAAAAAAAAAAADoN6AQ/original imageType: primary + row: 8 - title: Good Compatibility with Micro Apps description: Ant Design Style is compatible with qiankun micro apps by default (with a slight performance sacrifice). It also provides performance optimization options for scenarios that do not require micro apps. image: https://mdn.alipayobjects.com/huamei_rqvucu/afts/img/A*tZNeQIUYx_4AAAAAAAAAAAAADoN6AQ/original imageType: primary - row: 6 + row: 8 - title: Application Cases description: Showcases various cases of components and applications using Ant Design Style, helping developers get started quickly. This documentation is also built using Ant Design Style and can serve as a reference for static site construction. link: /case image: https://mdn.alipayobjects.com/huamei_rqvucu/afts/img/A*5H2ySLO-X4cAAAAAAAAAAAAADoN6AQ/original imageType: soon - row: 8 + row: 9 - title: Easy Responsive Adaptation description: Ant Design Style will provide convenient utility functions for responsive applications, helping developers quickly complete responsive theme development. image: https://mdn.alipayobjects.com/huamei_rqvucu/afts/img/A*5H2ySLO-X4cAAAAAAAAAAAAADoN6AQ/original - row: 6 + row: 7 --- -```