Skip to content

Commit df12c74

Browse files
committed
chores: update doc badge & fix .npmignore
1 parent 9c489c8 commit df12c74

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

.npmignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ dev
66
.gitignore
77
webpack.config.js
88
dist/**
9-
!dist/main.js
9+
!dist/main.js
10+
!dist/main.js.LICENSE.txt

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
<h1 align='center'>netlify-cms-widget-simplemde</h1>
22

3-
<p align='center'>Replacement of markdown widget</p>
3+
<p align='center'>
4+
<a href="https://github.com/iamspark1e/netlify-cms-widget-simplemde"><img src="https://data.jsdelivr.com/v1/package/npm/netlify-cms-widget-simplemde/badge" /></a>
5+
</p>
6+
7+
<p align='center'>Replacement of NetlifyCMS (Decap CMS) Markdown widget</p>
48
<br />
59

610
### Quick Start
711

812
Add below script code after Netlify CMS script tag,
913

1014
```html
11-
<script src="https://www.unpkg.com/netlify-cms-widget-simplemde"></script>
15+
<script src="https://cdn.jsdelivr.net/npm/netlify-cms-widget-simplemde/dist/main.min.js"></script>
16+
<!-- OR use unpkg CDN -->
17+
<!-- <script src="https://www.unpkg.com/netlify-cms-widget-simplemde"></script> -->
1218
<script>
1319
CMS.registerWidget("simplemde", SimpleMDEControl, SimpleMDEPreview);
1420
</script>
1521
```
1622

1723
Then, change your original `"widget": "markdown"` into `"widget": "simplemde"`.
1824

19-
Just so simple, I tested Chinese and works well.
25+
Just so simple, I tested Chinese and works well. (Old markdown widget cannot input Chinese characters fluently.)
2026

2127
Any feature or suggests are welcomed!

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
"main": "dist/main.js",
66
"keywords": [
77
"netlify-cms-widget",
8+
"decap-cms-widget",
89
"netlify-cms",
10+
"decap-cms",
911
"markdown",
1012
"simplemde",
1113
"easymde"

0 commit comments

Comments
 (0)