Skip to content

Commit

Permalink
feat!: add VIP provider mode
Browse files Browse the repository at this point in the history
  • Loading branch information
terwer committed Sep 2, 2024
1 parent a4af80f commit f6f174f
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 6 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,19 @@ Based on the localization concept of siyuan-note , this plugin is natively share

The core idea of this plugin is: `Everything is a Page` . You can set a page to be the home page.

> Important:
> 1. Version 1.8.0+ unifies the sharing logic in public sharing and authorization code mode, so you need to initialize the sharing type to avoid the old sharing link access exception, you only need to open the sharing pop-up window once, and it will be automatically initialized after opening.
> 2. Sharing in 1.8.0+ authorization code mode can also support image display, go and try it 😄
> Important Notice:
> 1. Version 2.0.0 introduces support for VIP versions, distinguished as follows:
/s/[id] - Regular Link
/static/[id] - Regular Link
/p/[id] - Regular Link
/post/[id] - Regular Link
-----------------------------------------------------------------------------------
/doc/[id] - VIP Exclusive Link, "Only used when deploying in VIP Service Provider mode"
/article/[id] - VIP Exclusive Link, "Only used when deploying in VIP Service Provider mode"
/share/[id] - VIP Exclusive Link, "Only used when deploying in VIP Service Provider mode"
/x/[id] - VIP Exclusive Link, "Only used when deploying in VIP Service Provider mode"
/a/[id] - VIP Exclusive Link, "Only used when deploying in VIP Service Provider mode"
/d/[id] - VIP Exclusive Link, "Only used when deploying in VIP Service Provider mode"

[docs](https://blog.terwer.space/s/20230621001422-xsimx5v)

Expand All @@ -29,6 +39,7 @@ The core idea of this plugin is: `Everything is a Page` . You can set a page to
- [Expert-Level] Self-Deployment using Docker: Requires purchasing a server, SSR server-side rendering, SEO-friendly, high speed.
- [Cost-Free Option] Vercel Hosting: Requires purchasing a domain and may not be accessible in some countries, low cost, moderate speed.
* **Sharing mode (experimental)**: Public note sharing is supported by default, and limited sharing functions can be supported after enabling the authorization code.
* **VIP Service Provider Mode**<sup>2.0.0+</sup>: Allows deploying this project as a VIP service provider, requiring backend sharing service(eg. https://github.com/terwerinc/siyuan-note-service) support.

## TODO

Expand Down
16 changes: 14 additions & 2 deletions README_zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,18 @@
本插件的核心理念是:`一切皆页面` 。您可以设置某个页面为主页。

> 重要提示:
> 1. 1.8.0+ 版本对公共分享和授权码模式下的分享逻辑进行了统一处理,因此需要初始化分享类型,避免旧的分享链接访问异常,您只需要打开一次分享弹窗即可,打开之后会自动初始化。
> 2. 1.8.0+ 授权码模式下的分享也能支持图片显示啦,快去试试吧😄
> 1. 2.0.0,新增适配 VIP 版本,并区分如下:
/s/[id] - 普通链接
/static/[id] - 普通链接
/p/[id] - 普通链接
/post/[id] - 普通链接
-----------------------------------------------------------------------------------
/doc/[id] - VIP 专属链接,「仅 VIP 服务商模式部署时使用」
/article/[id] - VIP 专属链接,「仅 VIP 服务商模式部署时使用」
/share/[id] - VIP 专属链接,「仅 VIP 服务商模式部署时使用」
/x/[id] - VIP 专属链接,「仅 VIP 服务商模式部署时使用」
/a/[id] - VIP 专属链接,「仅 VIP 服务商模式部署时使用」
/d/[id] - VIP 专属链接,「仅 VIP 服务商模式部署时使用」

[帮助文档](https://blog.terwer.space/s/20230621001422-xsimx5v)

Expand All @@ -28,7 +38,9 @@
- [入门级]思源笔记插件:零配置,开箱即用,本地SPA应用,直接访问思源本体,因此速度极快,但是SEO不太友好
- [高手级]docker自部署:需要自己购买服务器,SSR服务端渲染,SEO友好,速度快
- [白嫖级]Vercel托管:需要自己购买域名,否则可能无法访问,成本低,速度适中
- [零部署]<sup>new</sup>在 VIP 服务商模式下,用户只需要安装 [在线分享专业版](https://github.com/terwerinc/siyuan-plugin-share-pro) 即可使用,此项目作为服务商部署版本。
- **分享模式**:默认支持公共笔记分享,开启授权码之后可支持有限的分享功能。
- **VIP 服务商模式**<sup>2.0.0+</sup>:可以部署此项目作为 VIP 服务商,需要后端分享服务(例如:https://github.com/terwerinc/siyuan-note-service )支持

## TODO

Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,6 @@
"pinia": "^2.1.6",
"zhi-device": "^2.3.0",
"zhi-siyuan-api": "^2.0.20"
}
},
"packageManager": "pnpm@9.6.0+sha512.38dc6fba8dba35b39340b9700112c2fe1e12f10b17134715a4aa98ccf7bb035e76fd981cf0bb384dfa98f8d6af5481c2bef2f4266a24bfa20c34eb7147ce0b5e"
}

0 comments on commit f6f174f

Please sign in to comment.