@zephyr424/wb-sdk 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/deploy.yml +41 -0
- package/README.md +4 -4
- package/data/top5000.json +55002 -0
- package/docs/.vitepress/config.mjs +112 -0
- package/docs/api/review.md +155 -0
- package/docs/api/types.md +0 -0
- package/docs/api/word.md +189 -0
- package/docs/blog/designing-api.md +30 -0
- package/docs/blog/index.md +19 -0
- package/docs/blog/publishing-to-npm.md +36 -0
- package/docs/blog/why-sm2.md +26 -0
- package/docs/contributors.md +16 -0
- package/docs/en/api/word.md +189 -0
- package/docs/en/blog/index.md +0 -0
- package/docs/en/guide/index.md +28 -0
- package/docs/en/index.md +25 -0
- package/docs/guide/index.md +100 -0
- package/docs/index.md +39 -0
- package/docs/package-lock.json +2564 -0
- package/docs/package.json +19 -0
- package/index.js +1 -1
- package/package.json +12 -7
- package/scripts/build-wordlist.js +26 -0
- package/src/wordBank.js +19 -1
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
name: Deploy VitePress site to Pages
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
workflow_dispatch:
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
pages: write
|
|
11
|
+
id-token: write
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
build:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
- uses: actions/setup-node@v4
|
|
19
|
+
with:
|
|
20
|
+
node-version: 20
|
|
21
|
+
- name: Setup Pages
|
|
22
|
+
uses: actions/configure-pages@v4
|
|
23
|
+
- name: Install dependencies
|
|
24
|
+
run: cd docs && npm install
|
|
25
|
+
- name: Build
|
|
26
|
+
run: cd docs && npm run docs:build
|
|
27
|
+
- name: Upload artifact
|
|
28
|
+
uses: actions/upload-pages-artifact@v3
|
|
29
|
+
with:
|
|
30
|
+
path: docs/.vitepress/dist
|
|
31
|
+
|
|
32
|
+
deploy:
|
|
33
|
+
environment:
|
|
34
|
+
name: github-pages
|
|
35
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
36
|
+
runs-on: ubuntu-latest
|
|
37
|
+
needs: build
|
|
38
|
+
steps:
|
|
39
|
+
- name: Deploy to GitHub Pages
|
|
40
|
+
id: deployment
|
|
41
|
+
uses: actions/deploy-pages@v4
|
package/README.md
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
> A developer-friendly spaced repetition engine for vocabulary building
|
|
4
4
|
|
|
5
|
-
[](https://www.npmjs.com/package/wb-sdk)
|
|
6
|
-
[](https://www.npmjs.com/package/@zephyr424/wb-sdk)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
7
|
|
|
8
8
|
**wb-sdk** is a lightweight, plug-and-play spaced repetition engine designed for developers who want to integrate intelligent vocabulary review into their applications.
|
|
9
9
|
|
|
@@ -25,11 +25,11 @@ Stop reinventing the wheel — just `npm install wb-sdk` and start building.
|
|
|
25
25
|
## 🚀 Installation
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
|
-
npm install wb-sdk
|
|
28
|
+
npm install @zephyr424/wb-sdk
|
|
29
29
|
```
|
|
30
30
|
### Or with Yarn:
|
|
31
31
|
```bash
|
|
32
|
-
yarn add wb-sdk
|
|
32
|
+
yarn add @zephyr424/wb-sdk
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
---
|