diff --git a/example/docs/config/markdown.en-US.md b/example/docs/config/markdown.en-US.md index 7a73aac..90b6ad6 100644 --- a/example/docs/config/markdown.en-US.md +++ b/example/docs/config/markdown.en-US.md @@ -4,7 +4,9 @@ nav: order: 2 title: Markdown Config --- + All Markdown configurations are configured in the form of FrontMatter at the top of the Markdown file, for example + ``` --- title: configure page title @@ -12,6 +14,7 @@ title: configure page title Additional Markdown content ``` + Currently the theme supports the following Markdown configurations. ## Multi-level sidebar @@ -19,11 +22,11 @@ Currently the theme supports the following Markdown configurations. > This configuration needs to be distinguished from the `sidebarEnhance` parameter. The `sidebarEnhance` parameter is to deal with issues such as multi-level file directories, custom sidebars, and preventing multi-level sidebar clicks and jumps. The Markdown configuration is in the same Under the file directory, functions such as grouping and three-level sidebars are realized through configuration. - This configuration only takes effect in non-sidebarGroupModePath mode. + This configuration only takes effect in none sidebarGroupModePath mode. -Configuring multi-level sidebars mainly depends on two fields `group` and `type`, `group` configures the first-level sidebar, and `type` configures the second-level sidebar. -First level sidebar configuration: +Configuring multi-level sidebars mainly depends on two fields `group` and `type`, `group` configures the first-level sidebar, and `type` configures the second-level sidebar. First level sidebar configuration: + ``` --- @@ -39,9 +42,11 @@ order: 1 title: '布局' --- ``` + ![side-menu-1](https://github-production-user-asset-6210df.s3.amazonaws.com/20694238/242193437-38a1cd75-493f-4c23-96d2-0ecd2fad662c.png) Second level sidebar configuration: + ``` --- @@ -66,13 +71,15 @@ order: 0 title: '数据可视化页' --- ``` + ![side-menu-2](https://github-production-user-asset-6210df.s3.amazonaws.com/20694238/242193448-133ef65c-7ad6-4531-adcd-5e70d9bda289.png) The `group` field type supports object format, which is used to adjust the display order of `group`. For example, setting the `order` field in `group` can adjust the order of `global style` and `design mode`: + ``` --- -group: +group: title: '全局样式' order: 2 order: 1 @@ -88,4 +95,5 @@ order: 0 title: '概览' --- ``` -![side-menu-3](https://github-production-user-asset-6210df.s3.amazonaws.com/20694238/242193454-eb63d438-1cd8-41d1-8563-c628245bda09.png) \ No newline at end of file + +![side-menu-3](https://github-production-user-asset-6210df.s3.amazonaws.com/20694238/242193454-eb63d438-1cd8-41d1-8563-c628245bda09.png) diff --git a/example/docs/guide/builtins-alert.zh-CN.md b/example/docs/guide/builtins-alert.zh-CN.md index 2945758..317d5a1 100644 --- a/example/docs/guide/builtins-alert.zh-CN.md +++ b/example/docs/guide/builtins-alert.zh-CN.md @@ -1,12 +1,9 @@ --- -group: - title: 内置组件 -order: 2 +group: 内置组件 title: 警告提示 +order: 1 --- -## Alert 0.2.5+ - 警告提示，展现需要关注的信息，使用方法同 `antd` [Alert](https://ant.design/components/alert-cn) 组件，该组件支持 `type`、`closable`以及`showIcon`参数，类型与之保持一致。 ```markdown diff --git a/example/docs/guide/builtins-component.zh-CN.md b/example/docs/guide/builtins-image-preview.zh-CN.md similarity index 80% rename from example/docs/guide/builtins-component.zh-CN.md rename to example/docs/guide/builtins-image-preview.zh-CN.md index 0cab5e7..1c94a7c 100644 --- a/example/docs/guide/builtins-component.zh-CN.md +++ b/example/docs/guide/builtins-image-preview.zh-CN.md @@ -1,58 +1,9 @@ --- -order: 3 -title: 内置组件 +group: 内置组件 +title: 图片预览 +order: 2 --- -为了更加方便地在 Markdown 中使用一些组件，增强 Markdown 展示效果，主题内置一些常见组件，具体如下： - -## Alert 0.2.5+ - -警告提示，展现需要关注的信息，使用方法同 `antd` [Alert](https://ant.design/components/alert-cn) 组件，该组件支持 `type`、`closable`以及`showIcon`参数，类型与之保持一致。 - -```markdown - - Text - - - - Success Text - - - - Info Text - - - - Warning Text - - - - Error Text - -``` - - - Text - - - - Success Text - - - - Info Text - - - - Warning Text - - - - Error Text - - -## ImagePreview 0.2.7+ - 图片预览组件，需要展示图片时使用。该组件支持 `float` 以及 `pure` 两个参数，用于控制图片展示效果。 ### 基础使用 diff --git a/example/docs/guide/builtins-overview.zh-CN.md b/example/docs/guide/builtins-overview.zh-CN.md new file mode 100644 index 0000000..bec3242 --- /dev/null +++ b/example/docs/guide/builtins-overview.zh-CN.md @@ -0,0 +1,13 @@ +--- +group: + title: 内置组件 + order: 3 +order: 0 +title: 概览 +--- + +为了更加方便地在 Markdown 中使用一些组件，增强 Markdown 展示效果，主题内置一些常见组件，具体包含以下组件： + +- [Alert](./builtins-alert.zh-CN.md) 0.2.5+ +- [ImagePreview](./builtins-image-preview.zh-CN.md) 0.2.7+ +- [Alert](./builtins-alert.zh-CN.md) diff --git a/example/docs/guide/changelog.en-US.md b/example/docs/guide/changelog.en-US.md index 38ca62e..69fc8b1 100644 --- a/example/docs/guide/changelog.en-US.md +++ b/example/docs/guide/changelog.en-US.md @@ -1,5 +1,5 @@ --- -order: 4 +order: 5 title: Change Log toc: false timeline: true