Merge branch 'main' of github.com:kktjs/markdown-react-code-preview-loader

Author: SunLxy

.github/workflows/ci.yml

@@ -18,8 +18,66 @@ jobs:
       - run: npm run build
       - run: npm run doc
 
+      - name: Generate Contributors Images
+        uses: jaywcjlove/github-action-contributors@main
+        with:
+          filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\])
+          output: ./website/build/CONTRIBUTORS.svg
+          avatarSize: 42
+
+      - name: Create Tag
+        id: create_tag
+        uses: jaywcjlove/create-tag-action@v1.3.6
+        with:
+          package-path: ./core/package.json
+
+      - name: get tag version
+        id: tag_version
+        uses: jaywcjlove/changelog-generator@v1.5.3
+
+      - 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
+
+      - name: Generate Changelog
+        id: changelog
+        uses: jaywcjlove/changelog-generator@v1.5.3
+        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/markdown-react-code-preview-loader@${{steps.changelog.outputs.version}}/file/README.md) [![npm version](https://img.shields.io/npm/v/markdown-react-code-preview-loader.svg)](https://www.npmjs.com/package/markdown-react-code-preview-loader)
+            
+            Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/kktjs/markdown-react-code-preview-loader/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html  
+            Comparing Changes: ${{ steps.changelog.outputs.compareurl }}  
+
+            ```bash
+            npm i markdown-react-code-preview-loader@${{steps.changelog.outputs.version}}
+            ```
+
+            ${{ steps.changelog.outputs.changelog }}
+
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./website/build
+          publish_dir: ./website/build
+
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          package: ./core/package.json

core/README-zh.md

@@ -1,6 +1,10 @@
 markdown-react-code-preview-loader
 ===
 
+[![CI](https://github.com/kktjs/markdown-react-code-preview-loader/actions/workflows/ci.yml/badge.svg)](https://github.com/kktjs/markdown-react-code-preview-loader/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/markdown-react-code-preview-loader.svg)](https://www.npmjs.com/package/markdown-react-code-preview-loader)
+[![npm unpkg](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/markdown-react-code-preview-loader/file/README.md)
+
 索引 Markdown 中的示例文本，转换为 React 组件。当前包是 `webpack` 的 `loader`，通过配置当前 `loader` 加载 `markdown` 文档，返回一个 `JS` 对象，包含 `markdown` 文本，`markdown` 文本中的示例索引。
 
 ## 安装 Loader
@@ -111,8 +115,8 @@ export type CodeBlockData = {
 2. `mdx:preview` 控制是否进行进行示例索引，通过对应所在行号，获取需要的示例对象。
 3. `mdx:preview:demo12` 通过 `demo12` 唯一标识，准确获取索引的 `示例代码` 或 `示例组件对象`。
 
-```markdown mdx:preview
-\```tsx
+```markdown
+\```tsx mdx:preview
 import React from "react"
 const Demo = ()=>{
   return <div>测试</div>
@@ -131,7 +135,7 @@ export default Demo
 \```
 ```
 
-## Development
+## 开发
 
 ```bash
 npm install   # Install dependencies
@@ -140,6 +144,17 @@ npm run hoist # Install sub packages dependencies
 npm run watch:loader
 npm run start
 ```
+
+## 贡献者
+
+一如既往，感谢我们出色的贡献者！
+
+<a href="https://github.com/kktjs/markdown-react-code-preview-loader/graphs/contributors">
+  <img src="https://kktjs.github.io/markdown-react-code-preview-loader/CONTRIBUTORS.svg" />
+</a>
+
+由 [action-contributors](https://github.com/jaywcjlove/github-action-contributors) 生成。
+
 ### License
 
 Licensed under the MIT License.

core/README.md

@@ -1,6 +1,10 @@
 markdown-react-code-preview-loader
 ===
 
+[![CI](https://github.com/kktjs/markdown-react-code-preview-loader/actions/workflows/ci.yml/badge.svg)](https://github.com/kktjs/markdown-react-code-preview-loader/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/markdown-react-code-preview-loader.svg)](https://www.npmjs.com/package/markdown-react-code-preview-loader)
+[![npm unpkg](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/markdown-react-code-preview-loader/file/README.md)
+
 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.
 
 ## Install Loader
@@ -111,8 +115,8 @@ Note: You need to add a special `meta` identifier to the code block example, and
 2. `mdx:preview` Controls whether to perform example indexing, and obtain the required example object through the corresponding line number.
 3. `mdx:preview:demo12` Uniquely identified by `demo12`, accurately obtain the `example code` or `example component object` of the index.
 
-```markdown mdx:preview
-\```tsx
+```markdown
+\```tsx mdx:preview
 import React from "react"
 const Demo = ()=>{
   return <div>测试</div>
@@ -140,6 +144,17 @@ npm run hoist # Install sub packages dependencies
 npm run watch:loader
 npm run start
 ```
+
+## Contributors
+
+As always, thanks to our amazing contributors!
+
+<a href="https://github.com/kktjs/markdown-react-code-preview-loader/graphs/contributors">
+  <img src="https://kktjs.github.io/markdown-react-code-preview-loader/CONTRIBUTORS.svg" />
+</a>
+
+Made with [action-contributors](https://github.com/jaywcjlove/github-action-contributors).
+
 ### License
 
 Licensed under the MIT License.

core/package.json

@@ -13,6 +13,8 @@
   "module": "esm/index.js",
   "types": "lib/index.d.ts",
   "files": [
+    "README-zh.md",
+    "README.md",
     "lib",
     "src",
     "esm"