Skip to content

Commit a956883

Browse files
committed
doc: Update the introduction.
1 parent 96e7a1c commit a956883

File tree

4 files changed

+71
-4
lines changed

4 files changed

+71
-4
lines changed

.github/workflows/ci.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Build & Deploy
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
build-deploy:
9+
runs-on: ubuntu-18.04
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: actions/setup-node@v2
13+
with:
14+
node-version: 14
15+
16+
- run: npm install
17+
- run: npm run build
18+
- run: npm run doc
19+
- run: npm run test:coverage
20+
21+
- run: npm install @jsdevtools/npm-publish -g
22+
- run: npm-publish --token="${{ secrets.NPM_TOKEN }}" ./package.json
23+
24+
- name: Create Tag
25+
id: create_tag
26+
uses: jaywcjlove/create-tag-action@v1.2.0
27+
with:
28+
token: ${{ secrets.GITHUB_TOKEN }}
29+
package-path: ./package.json
30+
31+
- name: Generate Changelog
32+
id: changelog
33+
uses: jaywcjlove/changelog-generator@v1.4.2
34+
with:
35+
token: ${{ secrets.GITHUB_TOKEN }}
36+
head-ref: ${{steps.create_tag.outputs.version}}
37+
filter-author: (jaywcjlove|小弟调调™|dependabot\[bot\]|Renovate Bot)
38+
filter: '[R|r]elease[d]\s+[v|V]\d(\.\d+){0,2}'
39+
40+
- name: Deploy
41+
uses: peaceiris/actions-gh-pages@v3
42+
with:
43+
github_token: ${{ secrets.GITHUB_TOKEN }}
44+
publish_dir: ./build
45+
46+
- name: Create Release
47+
uses: ncipollo/release-action@v1
48+
if: steps.create_tag.outputs.successful
49+
with:
50+
token: ${{ secrets.GITHUB_TOKEN }}
51+
name: ${{ steps.create_tag.outputs.version }}
52+
tag: ${{ steps.create_tag.outputs.version }}
53+
body: |
54+
[![](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-textarea-code-editor@${{steps.create_tag.outputs.versionNumber}}/file/README.md) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/@uiw/react-textarea-code-editor)](https://bundlephobia.com/result?p=@uiw/react-textarea-code-editor@${{steps.create_tag.outputs.versionNumber}})
55+
56+
```bash
57+
npm i @uiw/react-textarea-code-editor@${{steps.create_tag.outputs.versionNumber}}
58+
```
59+
60+
${{ steps.changelog.outputs.compareurl }}
61+
62+
${{ steps.changelog.outputs.changelog }}
63+
64+
- name: Coveralls
65+
uses: coverallsapp/github-action@master
66+
with:
67+
github-token: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ React Textarea Code Editor
22
===
33
<!--rehype:style=display:none;-->
44

5-
A simple no-frills code editor with syntax highlighting.
5+
A simple code editor with syntax highlighting.
66

77
## Install
88

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@uiw/react-textarea-code-editor",
33
"version": "6.10.4",
4-
"description": "A simple no-frills code editor with syntax highlighting.",
4+
"description": "A simple code editor with syntax highlighting.",
55
"homepage": "https://uiwjs.github.io/react-textarea-code-editor/",
66
"private": true,
77
"main": "lib/cjs/index.js",

public/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta charset="utf-8">
66
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
77
<meta name="theme-color" content="#000000">
8-
<meta name="description" content="A simple no-frills code editor with syntax highlighting." />
8+
<meta name="description" content="A simple code editor with syntax highlighting." />
99
<meta name="keywords" content="react,component,textarea,js,css,html,preview,editor" />
1010
<!--<link rel="manifest" href="%PUBLIC_URL%/manifest.json">-->
1111
<link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
@@ -18,7 +18,7 @@
1818
work correctly both with client-side routing and a non-root public URL.
1919
Learn how to configure a non-root public URL by running `npm run build`.
2020
-->
21-
<title>React Textarea Code Editor - A simple no-frills code editor with syntax highlighting.</title>
21+
<title>React Textarea Code Editor - A simple code editor with syntax highlighting.</title>
2222
</head>
2323

2424
<body>

0 commit comments

Comments
 (0)