admin/artalkjs

0 Fork 0

Files

T

qwqcode 069a33773c docs: refine and add frontend api docs

Signed-off-by: qwqcode <qwqcode@gmail.com>

2023-03-10 20:17:41 +08:00

1.4 KiB

Raw Permalink Blame History

开发说明

参考资源

📖 开发者贡献指南 (CONTRIBUTING.md)

🔬 HTTP API 文档 (OpenAPI)

🔖 贡献者契约行为准则 (CODE_OF_CONDUCT.md)

配置文档

补充说明

由于 Artalk 正处于开发阶段，使用此文档中 API、Event 前请务必检查时效性。

API 部分参考源码
- @ArtalkJS/Artalk - src/api/
- @ArtalkJS/Artalk - server/server.go
UI 及 Event 部分参考源码
- @ArtalkJS/Artalk - src/artalk.ts
- @ArtalkJS/Artalk - types/event.d.ts

通过 Artalk 提供的 API 和 Event，你可以实现很多高级功能，比如编写评论管理机器人、评论提醒推送插件等。Artalk 并不为此提供技术指导，但鼓励你参考此处的文档自行定制。