Skip to content

Commit 19e1487

Browse files
committed
doc: Update README.md
1 parent 690d881 commit 19e1487

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

core/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ react-code-preview-layout
44
[![CI](https://github.com/uiwjs/react-code-preview-layout/actions/workflows/ci.yml/badge.svg)](https://github.com/uiwjs/react-code-preview-layout/actions/workflows/ci.yml)
55
[![NPM version](https://img.shields.io/npm/v/react-code-preview-layout.svg?style=flat)](https://npmjs.org/package/react-code-preview-layout)
66

7-
用于简化示例代码块与示例预览布局 ,内置`@uiw/react-codepen``@uiw/react-codesandbox`依赖,用于动态地从代码示例生成`codepen`项目和`codesandbox`项目。
7+
展示 `代码``代码在线预览示例` 布局的一个 react 组件。配合 [markdown-react-code-preview-loader](https://github.com/kktjs/markdown-react-code-preview-loader) Webpack Loader 可很好的用于文档中的 react 示例展示。
8+
9+
组件内置 [`@uiw/react-codepen`](https://github.com/uiwjs/react-codepen)[`@uiw/react-codesandbox`](https://github.com/uiwjs/react-codesandbox) 依赖,用于动态地将代码示例生成 [`codepen`](https://github.com/uiwjs/react-codepen) 项目和 [`codesandbox`](https://codesandbox.io/) 项目。
810

911
```bash
1012
npm install react-code-preview-layout --save

core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-code-preview-layout",
33
"version": "1.0.0",
4-
"description": "Code preview layout component",
4+
"description": "A react component showing the layout of `code` and `code preview example`.",
55
"author": "SunLxy <[email protected]>",
66
"contributors": [
77
"SunLxy <[email protected]>",

0 commit comments

Comments
 (0)