文档示例

此页面列举了 dumi 渲染各项 Markdown 样式以及 Demo 的效果。

Demo 嵌入

渲染示例 - 图1

  1. import React from 'react';
  2. import { Button } from 'antd';
  3. export default () => <Button type="primary">我是 antd 的按钮</Button>;

外部 Demo

  1. import React from 'react';
  2. import { Button, Modal } from 'antd';
  3. class App extends React.Component {
  4. state = { visible: false };
  5. showModal = () => {
  6. this.setState({
  7. visible: true,
  8. });
  9. };
  10. handleOk = e => {
  11. console.log(e);
  12. this.setState({
  13. visible: false,
  14. });
  15. };
  16. handleCancel = e => {
  17. console.log(e);
  18. this.setState({
  19. visible: false,
  20. });
  21. };
  22. render() {
  23. return (
  24. <div>
  25. <Button type="primary" onClick={this.showModal}>
  26. Open Modal
  27. </Button>
  28. <Modal
  29. title="Basic Modal"
  30. visible={this.state.visible}
  31. onOk={this.handleOk}
  32. onCancel={this.handleCancel}
  33. >
  34. <p>Some contents...</p>
  35. <p>Some contents...</p>
  36. <p>Some contents...</p>
  37. </Modal>
  38. </div>
  39. );
  40. }
  41. }
  42. export default () => <App />;

TS 转 JS

如果我们的 demo 是采用 TSX 编写的,在展开源代码后,点击一旁的语言切换按钮,可切换显示成 JSX 的代码

  1. import React from 'react';
  2. import { Button } from 'antd';
  3. type MsgType = string;
  4. function hello(msg: MsgType) {
  5. alert(msg);
  6. }
  7. export default () => (
  8. <Button type="primary" onClick={hello.bind(null, 'Hello!')}>
  9. 点击我就 Hello!
  10. </Button>
  11. );

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

水平线


强调样式

字体加粗

斜体样式

删除线样式

引用

引用可以被嵌套

只要引用符号比上一级多就能产生嵌套

列表

无序列表

  • 使用 +-* 来创建无序列表
  • 列表可以嵌套,嵌套会产生缩进
    • 我是子列表项

有序列表

  1. dumi 不基于 father
  2. dumi 基于 Umi
  3. dumi 核心是一个 Umi 插件

代码

行内 code

代码块:

  1. // some code here

语法高亮

  1. console.log('Hello World!');

表格

名词 解释
father Library toolkit based on rollup, docz, storybook, jest, prettier and eslint.
Umi Pluggable enterprise-level react application framework.

单元格右对齐

名词 解释
father Library toolkit based on rollup, docz, storybook, jest, prettier and eslint.
Umi Pluggable enterprise-level react application framework.

超链接

前往 Umi 官网

自动转换超链接 https://umijs.org