Skip to content

Commit

Permalink
docs(guide): 调整内置组件导航为二级(en-US)
Browse files Browse the repository at this point in the history
  • Loading branch information
KuangPF committed Jul 16, 2023
1 parent 1374bff commit a10b18b
Show file tree
Hide file tree
Showing 5 changed files with 172 additions and 0 deletions.
49 changes: 49 additions & 0 deletions example/docs/guide/builtins-alert.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
group: Builtins Components
title: Alert
order: 1
---

Warning prompt, showing the information that needs attention, using the same method as the `antd` [Alert](https://ant.design/components/alert-cn) component, which supports `type`, `closable` and `showIcon` parameters , with the same type.

```markdown
<Alert>
Text
</Alert>

<Alert type="success" showIcon >
Success Text
</Alert>

<Alert type="info">
Info Text
</Alert>

<Alert type="warning">
Warning Text
</Alert>

<Alert type="error" closable >
Error Text
</Alert>
```

<Alert>
Text
</Alert>

<Alert type="success" showIcon >
Success Text
</Alert>

<Alert type="info">
Info Text
</Alert>

<Alert type="warning">
Warning Text
</Alert>

<Alert type="error" closable >
Error Text
</Alert>
71 changes: 71 additions & 0 deletions example/docs/guide/builtins-image-preview.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
group: Builtins Components
title: ImagePreview
order: 2
---

Image preview component, used when images need to be displayed. This component supports two parameters `float` and `pure`, which are used to control the image display effect.

### Basic usage

By default, the background color will be added to the image and the relevant spacing will be adjusted. `description` is the description of the image, which will be displayed below the image.

```md
<ImagePreview Preview>
<img description="Design Principles" src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*aFiGRbIvuH4AAAAAAAAAAABkARQnAQ" />
</ImagePreview>
```

<ImagePreview Preview>
<img description="Design Principles" src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*aFiGRbIvuH4AAAAAAAAAAABkARQnAQ" />
</ImagePreview>

### Simple mode

If you don't need effects such as background color and image centering, set the `pure` attribute.

```md
<ImagePreview pure>
<img description="Design Principles" src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*aFiGRbIvuH4AAAAAAAAAAABkARQnAQ" />
</ImagePreview>
```

<ImagePreview pure>
<img description="Design Principles" src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*aFiGRbIvuH4AAAAAAAAAAABkARQnAQ" />
</ImagePreview>

### Surround Mode

In this mode, the image will be displayed floating on the right, and the text will surround it. Set the `float` property to use this mode.

```md
<ImagePreview float>
<img src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*1c74TKxuEW4AAAAAAAAAAABkARQnAQ" />
</ImagePreview>

Brand color is one of the most intuitive visual elements to reflect product characteristics and communication concepts. When choosing a color, it is necessary to clarify the use scene and scope of the brand color in the interface. Choose the main color in the basic color palette, we recommend choosing the sixth color from light to dark in the color palette as the main color. The brand color of Ant Design is taken from the blue of the basic color palette, and the Hex value is `#1890ff`. The application scenarios include: key action points, operation status, important information highlighting, graphics and other scenarios.
```

<ImagePreview float>
<img src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*1c74TKxuEW4AAAAAAAAAAABkARQnAQ" />
</ImagePreview>

Brand color is one of the most intuitive visual elements to reflect product characteristics and communication concepts. When choosing a color, it is necessary to clarify the use scene and scope of the brand color in the interface. Choose the main color in the basic color palette, we recommend choosing the sixth color from light to dark in the color palette as the main color. The brand color of Ant Design is taken from the blue of the basic color palette, and the Hex value is `#1890ff`. The application scenarios include: key action points, operation status, important information highlighting, graphics and other scenarios.

### Display side by side

In some cases, multiple images need to be displayed side by side, just put multiple `<img />` tags in the `ImagePreview` component, and add `inline` class name to the `img` tags.

```md
<ImagePreview float>
<img class='bad inline' src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*di8jS5EWYSIAAAAAAAAAAABkARQnAQ" alt="bad inline" description="Do not place more than one in a button area Main button.">
<img class='good inline' src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*3WUkT5pD1SUAAAAAAAAAAABkARQnAQ" alt="correct demonstration" description="1. Emphasize a main operation;< br/>2. There is no primary or secondary operation, and the secondary button is the safest choice.">
</ImagePreview>
```

<ImagePreview float>
<img class='bad inline' src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*di8jS5EWYSIAAAAAAAAAAABkARQnAQ" alt="bad inline" description="Do not place more than one in a button area Main button.">
<img class='good inline' src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*3WUkT5pD1SUAAAAAAAAAAABkARQnAQ" alt="correct demonstration" description="1. Emphasize a main operation;< br/>2. There is no primary or secondary operation, and the secondary button is the safest choice.">
</ImagePreview>

In this mode, comparison styles are also supported. For example, one is a positive example and the other is a negative example. You only need to add the class name `good` or `bad` to the corresponding `<img />`.
39 changes: 39 additions & 0 deletions example/docs/guide/builtins-install-dependencies.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
group: Builtins Components
title: InstallDependencies
order: 3
---

The dependent installation component is used to display script installation information. There are three built-in package managers `npm`, `yarn` and `pnpm`. The installation script statements are passed through different prop parameters:

- npm: Show `npm` package manager installation information
- yarn: show `yarn` package manager installation information
- pnpm: show `pnpm` package manager installation information

```md
<InstallDependencies
npm='$ npm install dumi-theme-antd --save'
yarn='$ yarn add dumi-theme-antd'
pnpm='$ pnpm install dumi-theme-antd --save'
/>
```

<InstallDependencies
npm='$ npm install dumi-theme-antd --save'
yarn='$ yarn add dumi-theme-antd'
pnpm='$ pnpm install dumi-theme-antd --save'
/>

Only some package managers are shown:

```md
<InstallDependencies
npm='$ npm install'
yarn='$ yarn'
/>
```

<InstallDependencies
npm='$ npm install'
yarn='$ yarn'
/>
13 changes: 13 additions & 0 deletions example/docs/guide/builtins-overview.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
group:
title: Builtins Components
order: 3
order: 0
title: overview
---

In order to use some components in Markdown more conveniently and enhance the display effect of Markdown, some common components are built into the theme, including the following components:

- [Alert](./builtins-alert.en-US.md) <Badge>0.2.5+</Badge>
- [ImagePreview](./builtins-image-preview.en-US.md) <Badge>0.2.7+</Badge>
- [InstallDependencies](./builtins-install-dependencies.en-US.md) <Badge>0.2.10+</Badge>

0 comments on commit a10b18b

Please sign in to comment.