Skip to content

Commit

Permalink
🌐 docs: 添加英文文档
Browse files Browse the repository at this point in the history
  • Loading branch information
arvinxx committed Mar 1, 2023
1 parent acc39e5 commit 4f3c75b
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions example/docs/guide/custom-footer.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
order: 2
title: Custom Footer
group:
title: Configuration
order: 4
---

# Custom Footer

Based on dumi's good theme architecture, we can easily customize the Footer of our site.

The Footer in this theme package is based on [rc-footer](https://github.com/react-component/footer) encapsulation. Therefore, this Footer component can support icons and other React components. This makes it impossible to configure the Footer column in the `themeConfig` and requires custom props to be passed into the Footer component.

Create a `.dumi/theme/slots` directory in your project and then create a `Footer` component in that directory with the following content:

```tsx | pure
//.dumi/theme/slots/Footer/index.tsx

import { Footer } from 'dumi-theme-antd-style';

export default () => {
return <Footer bottom={'Customized'} />;
};
```

The resulting code block looks like this:

```tsx
import { Footer } from 'dumi-theme-antd-style';

export default () => {
return <Footer bottom={'Customized'} />;
};
```

If you need to customize the columns, please refer to the Footer [source code](https://github.com/arvinxx/dumi-theme-antd-style/blob/master/src/slots/Footer/index.tsx) reference in this theme.

1 comment on commit 4f3c75b

@vercel
Copy link

@vercel vercel bot commented on 4f3c75b Mar 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.