Skip to content

Commit 2d0faa2

Browse files
committed
Update Docs
1 parent f6271e1 commit 2d0faa2

43 files changed

Lines changed: 4706 additions & 862 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ dist
1212
demo.zip
1313
text.html
1414
coverage
15+
16+
/docs/.vitepress/cache

DEPLOY.md

Lines changed: 0 additions & 312 deletions
This file was deleted.

README.md

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
[<img src="https://img.shields.io/badge/立刻使用-ffd91c?logo=cloudflarepages&style=for-the-badge&logoColor=000000" width="170"/>](https://abra.halu.ca/)
3030
[<img src="https://img.shields.io/badge/下载插件-8a54ff?logo=googlechrome&style=for-the-badge&logoColor=ffffff" width="170" />](#浏览器插件)
3131

32+
[<img src="https://img.shields.io/badge/项目完整文档-54ffac?style=for-the-badge" width="120" />](https://doc.abra.halu.ca)
3233
[<img src="https://img.shields.io/badge/前端源码仓库-9a10b5?style=for-the-badge" width="120" />](https://github.com/SheepChef/Abracadabra_demo)
33-
[<img src="https://img.shields.io/badge/贡献压缩字典-54ffac?style=for-the-badge" width="120" />](https://forms.gle/BBD5McqU6Bws6hiw6)
3434
[<img src="https://img.shields.io/badge/更新频道-0970ba?logo=telegram&style=for-the-badge&logoColor=ffffff" width="118" />](https://t.me/abracadabra_cn)
3535

3636
</div>
@@ -41,7 +41,7 @@
4141
---
4242

4343
✨ 查阅 [**快速使用**](#快速使用) 一节,以开始使用/部署本项目。
44-
✨ 查阅 [**细节和使用指南**](https://github.com/SheepChef/Abracadabra/blob/main/USAGE.md) 以深入了解本项目的细节。
44+
✨ 查阅 [**项目文档**](https://doc.abra.halu.ca),快速开始使用本项目。
4545

4646
👉 查阅 [**开放源代码许可**](#开放源代码许可) 一节,了解本项目的依赖项和许可证。
4747

@@ -82,43 +82,11 @@
8282

8383
## 快速使用
8484

85-
开发者请查阅 [**部署指南**](DEPLOY.md) 来了解详细部署方法。
85+
开发者请查阅 [**项目文档**](https://doc.abra.halu.ca) 来了解详细部署方法。
8686
要部署前端网页,请查阅 Release 和前端源代码仓库。
8787

8888
如果你是普通用户,请参考本文下方的内容。
8989

90-
### JavaScript
91-
92-
使用 npm 下载 Abracadabra 库。
93-
94-
你也可以前往 Release 页面直接下载Js文件。
95-
96-
```shell
97-
npm install abracadabra-cn
98-
```
99-
100-
然后,在项目中引入库文件
101-
102-
```javascript
103-
import { Abracadabra } from "abracadabra-cn";
104-
```
105-
106-
### WebAssembly
107-
108-
前往 Release 下载编译好的 WebAssembly 文件。
109-
110-
然后,使用 [**wasmtime**](https://github.com/bytecodealliance/wasmtime) 来调用它。
111-
112-
```shell
113-
114-
echo '{"method":"NEXT","mode":"ENCRYPT","inputType":"TEXT","outputType":"TEXT","input":"愿青空的祝福,与我的羽翼同在","key":"ABRACADABRA","q":true,"r":50,"p":false,"l":false}' | wasmtime abracadabra-cn.wasm
115-
116-
```
117-
118-
本项目的 WebAssembly 模块使用 [**Javy**](https://github.com/bytecodealliance/javy) 编译而来,方便在 C++、Rust、Go 等语言中调用,**不推荐**在类似 Python、 Java、Node.js 的解释器中调用。
119-
120-
要调用本 WebAssembly 模块,需要使用尚在预览状态的 [**WASI**](https://github.com/WebAssembly/WASI),目前仅有 wasmtime 提供了最完整的 WASI 支持,但它在各个语言的实现并不一致,具体请见 [**部署指南**](DEPLOY.md)
121-
12290
### 静态页面 / 前端源码
12391

12492
本项目有自动托管在Cloudflare Pages的静态页面可供直接使用。
@@ -158,7 +126,7 @@ APK文件可以 [**在 Release 中下载**](https://github.com/SheepChef/Abracad
158126

159127
## 细节概要
160128

161-
请查阅 [**细节和使用指南**](https://github.com/SheepChef/Abracadabra/blob/main/USAGE.md) 了解更多。
129+
请查阅 [**项目文档**](https://doc.abra.halu.ca) 了解更多。
162130

163131
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/SheepChef/Abracadabra)
164132

0 commit comments

Comments
 (0)