Merge branch 'main' of github.com:uiwjs/react-code-preview-layout

Author: SunLxy

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
   push:
-    branch:
+    branches:
       - main
 
 jobs:
@@ -29,8 +29,53 @@ jobs:
           output: ./website/build/CONTRIBUTORS.svg
           avatarSize: 42
 
+      - name: Create Tag
+        id: create_tag
+        uses: jaywcjlove/[email protected]
+        with:
+          package-path: ./core/package.json
+
+      - name: get tag version
+        id: tag_version
+        uses: jaywcjlove/[email protected]
+
       - name: Deploy Website
         uses: peaceiris/actions-gh-pages@v3
         with:
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          commit_message: ${{steps.tag_version.outputs.tag}} ${{ github.event.head_commit.message }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./website/build
+          publish_dir: ./website/build
+
+      - name: Generate Changelog
+        id: changelog
+        uses: jaywcjlove/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          filter-author: (jaywcjlove|小弟调调™|dependabot\[bot\]|Renovate Bot)
+          filter: (^[\s]+?[R|r]elease)|(^[R|r]elease)
+
+      - name: Create Release
+        uses: ncipollo/release-action@v1
+        if: steps.create_tag.outputs.successful
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          name: ${{ steps.create_tag.outputs.version }}
+          tag: ${{ steps.create_tag.outputs.version }}
+          body: |
+            [![](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/react-code-preview-layout@${{steps.changelog.outputs.version}}/file/README.md) [![npm version](https://img.shields.io/npm/v/react-code-preview-layout.svg)](https://www.npmjs.com/package/react-code-preview-layout)
+            
+            Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/uiwjs/react-code-preview-layout/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html  
+            Comparing Changes: ${{ steps.changelog.outputs.compareurl }}  
+
+            ```bash
+            npm i idoc@${{steps.changelog.outputs.version}}
+            ```
+
+            ${{ steps.changelog.outputs.changelog }}
+      
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          package: ./core/package.json

core/README.md

@@ -1,7 +1,12 @@
 react-code-preview-layout
-==========
+===
 
-用于简化示例代码块与示例预览布局 ,内置`@uiw/react-codepen`和`@uiw/react-codesandbox`依赖，用于动态地从代码示例生成`codepen`项目和`codesandbox`项目。
+[![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)
+[![NPM version](https://img.shields.io/npm/v/react-code-preview-layout.svg?style=flat)](https://npmjs.org/package/react-code-preview-layout)
+
+展示 `代码` 与 `代码在线预览示例` 布局的一个 react 组件。配合 [markdown-react-code-preview-loader](https://github.com/kktjs/markdown-react-code-preview-loader) Webpack Loader 可很好的用于文档中的 react 示例展示。
+
+组件内置 [`@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/)  项目。
 
 ```bash
 npm install react-code-preview-layout --save
@@ -138,7 +143,7 @@ npm run start
 一如既往，感谢我们出色的贡献者！
 
 <a href="https://github.com/uiwjs/react-code-preview-layout/graphs/contributors">
-  <img src="https://github.com/uiwjs/react-code-preview-layout/blob/gh-pages/CONTRIBUTORS.svg />
+  <img src="https://github.com/uiwjs/react-code-preview-layout/blob/gh-pages/CONTRIBUTORS.svg" />
 </a>
 
 由 [action-contributors](https://github.com/jaywcjlove/github-action-contributors) 生成。

core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-code-preview-layout",
   "version": "1.0.0",
-  "description": "Code preview layout component",
+  "description": "A react component showing the layout of `code` and `code preview example`.",
   "author": "SunLxy <[email protected]>",
   "contributors": [
     "SunLxy <[email protected]>",

website/public/index.html

@@ -6,7 +6,7 @@
     <meta name="theme-color" content="#000000" />
     <title>markdown-react-code-preview-loader</title>
     <meta name="keywords" content="react,loader,monorepo,react-component,component,webpack-loader,webpack5,webpack" />
-    <meta name="description" content="Index example text in Markdown, converted to React components. The current package is the `loader` of `webpack`, which loads the `markdown` document by configuring the current `loader`, returning a `JS` object containing the `markdown` text, the example index in the `markdown` text." />
+    <meta name="description" content="A react component showing the layout of code and code preview example." />
     <link rel="icon" href="%PUBLIC_URL%favicon.ico" />
     <!-- <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>🦖</text></svg>"> -->
   </head>