Skip to content

Commit 92bd6d0

Browse files
committed
feat: Configure automated NPM publishing, update package metadata, and add README badges.
Signed-off-by: Andrea Ferrario <andreaferrario02@gmail.com>
1 parent 2fd9aa8 commit 92bd6d0

6 files changed

Lines changed: 48 additions & 8 deletions

File tree

.github/workflows/publish.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Publish to NPM
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: read
12+
id-token: write
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: actions/setup-node@v4
16+
with:
17+
node-version: '20.x'
18+
registry-url: 'https://registry.npmjs.org'
19+
- run: npm ci
20+
- run: npm test
21+
- run: npm run build
22+
- run: npm publish
23+
env:
24+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.npmignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
src/
2+
test/
3+
.github/
4+
docs/
5+
.gitignore
6+
.npmignore
7+
jest.config.js
8+
package-lock.json

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Docsify Interactive Checkboxes Plugin
22

33
[![GitHub Pages](https://github.com/andreferra/docsify-plugin-interactive-checkboxes/actions/workflows/deploy.yml/badge.svg)](https://github.com/andreferra/docsify-plugin-interactive-checkboxes/actions/workflows/deploy.yml)
4+
[![npm version](https://badge.fury.io/js/docsify-interactive-checkboxes.svg)](https://badge.fury.io/js/docsify-interactive-checkboxes)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
46

57
A lightweight Docsify plugin that transforms standard markdown checkboxes into interactive, persistent task lists.
68

docs/plugin.min.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
{
22
"name": "docsify-interactive-checkboxes",
3-
"version": "1.0.0",
3+
"version": "2.0.1",
44
"description": "A lightweight Docsify plugin that transforms standard markdown checkboxes into interactive, persistent task lists",
55
"main": "src/plugin.js",
66
"unpkg": "dist/plugin.min.js",
77
"jsdelivr": "dist/plugin.min.js",
88
"files": [
99
"src",
10-
"dist"
10+
"dist",
11+
"README.md",
12+
"LICENSE"
1113
],
1214
"scripts": {
1315
"build": "terser src/plugin.js -o dist/plugin.min.js -c -m",
@@ -21,15 +23,16 @@
2123
},
2224
"keywords": [
2325
"docsify",
24-
"plugin",
26+
"docsify-plugin",
2527
"checkbox",
2628
"interactive",
2729
"todo",
2830
"task-list",
2931
"markdown",
30-
"persistent"
32+
"persistent",
33+
"localstorage"
3134
],
32-
"author": "Andrea Ferrario",
35+
"author": "Andrea Ferrario <andreaferrario02@gmail.com>",
3336
"license": "MIT",
3437
"bugs": {
3538
"url": "https://github.com/andreferra/docsify-plugin-interactive-checkboxes/issues"
@@ -39,5 +42,8 @@
3942
"jest": "^29.7.0",
4043
"jest-environment-jsdom": "^29.7.0",
4144
"terser": "^5.31.0"
45+
},
46+
"publishConfig": {
47+
"access": "public"
4248
}
4349
}

src/plugin.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
*
66
* @author Andrea Ferrario
77
* @license MIT
8-
* @version 2.0.0
8+
* @version 2.0.1
99
*/
1010

1111
(function () {

0 commit comments

Comments
 (0)