Skip to content

Commit 0c57a7d

Browse files
committed
feat: enhance documentation with new sections and updates
- Update API reference to clarify Extension API usage - Add FAQ section in Restful API overview for common queries - Revise user guide to include automation and integration tips - Improve clarity and structure across multiple documentation files
1 parent 14e808c commit 0c57a7d

File tree

5 files changed

+38
-6
lines changed

5 files changed

+38
-6
lines changed

content/docs/api-reference/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ MultiPost 提供的丰富的 API 接口,允许开发者远程调用我们的
88

99
## Extension API
1010

11-
我们通过 `window.postMessage` 来实现网页和扩展程序之间的通信。允许开发者调用我们的扩展程序的接口,来实现发布、获取账号信息、获取平台信息等功能。
11+
在你的 Web App 中,调用 MultiPost Extension 的接口,来实现发布、获取账号信息、获取平台信息等功能。
1212

1313
## Restful API (Beta, Only for Version above 1.1.0)
1414

@@ -17,8 +17,8 @@ MultiPost 提供的丰富的 API 接口,允许开发者远程调用我们的
1717
## What is Next?
1818

1919
<Cards>
20-
<Card title="Learn more about Extension API" href="/docs/api-reference/extension" />
21-
<Card title="Learn more about Restful API" href="/docs/api-reference/restful" />
20+
<Card title="Learn more about Extension API" href="/docs/api-reference/extension/overview" />
21+
<Card title="Learn more about Restful API" href="/docs/api-reference/restful/overview" />
2222
<Card title="MultiPost" href="https://multipost.app" />
2323
<Card title="User Guide" href="/docs/user-guide" />
2424
</Cards>

content/docs/api-reference/restful/overview.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,11 @@ Node (或者是 Client)是一个运行了 MultiPost 扩展的浏览器。需
3838

3939
### API Key
4040
API Key 是用于调用 Restful API 的凭证。
41+
42+
43+
## FAQ
44+
45+
### 1. 我想在无 UI 的 OS 服务器运行节点,可以吗?
46+
> 用 Headless 浏览器,理论上可以:能安装扩展,能正常访问互联网,能够登录社交媒体账号,基本就没有问题。
47+
> 但是需要你自行测试,开发组不保证可用性。
48+
> 如果你成功跑通工作流,欢迎[联系我们](/docs/user-guide/contact-us)分享,并收录到文档中。

content/docs/development/index.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: 开始开发
33
---
44

5+
## Overview
6+
Development 专题介绍 MultiPost Extension 的开发流程。帮助你快速参与开发社区,并贡献代码。
7+
8+
59
## 开始使用
610

711
首先,安装依赖:
@@ -55,4 +59,4 @@ pnpm build
5559

5660
我们非常欢迎你提出贡献,你可以通过 `pull request` 来提交你的代码。
5761

58-
在提交之前,请先阅读[贡献指南](../CONTRIBUTING.md)
62+
在提交之前,请先阅读[贡献指南](https://github.com/leaperone/MultiPost-Extension/blob/main/CONTRIBUTING.md)

content/docs/user-guide/contact-us.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ title: 联系我们
44

55
> 快速迭代中,不设置 Changelog。如需了解最新动态,请关注 QQ 群并关注推特:[海鱼Harry](https://x.com/harry_is_fish)
66
7+
## 如何提问
8+
9+
不要提问类似“为什么我发布不了”、“为什么我发布的内容没有显示”等问题,我们不提供此类问题解答。提问前请阅读[《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md),并提供详细的环境、版本以及错误信息;
10+
11+
请在 [GitHub Issues](https://github.com/MultiPost-Extension/MultiPost-Extension/issues) 中提出,等待社区反馈。
12+
13+
## 联系我们
714
- QQ群:[921137242](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=c5BjhD8JxNAuwjKh6qvCoROU301PppYU&authKey=NfKianfDwngrwJyVQbefIQET9vUQs46xb0PfOYUm6KzdeCjPd5YbvlRoO8trJUUZ&noverify=0&group_code=921137242)
815
- 邮箱:support@leaper.one
916
- GitHub Issues:https://github.com/leaperone/MultiPost-Extension/issues

content/docs/user-guide/quick-start.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,25 @@ title: 快速开始
2020

2121
在浏览器中,你可以直接使用 MultiPost 的扩展,也可以在 [multipost.app](https://multipost.app) 中创建和发布内容到多个平台。
2222

23+
## 自动化或者集成
24+
请参考 [API Reference](/docs/api-reference) 文档。
25+
2326

2427
## FAQ
25-
1. 为什么我的网页端正常发布内容,但是扩展不能正常发布?
28+
### 1. 为什么我的网页端正常发布内容,但是扩展不能正常发布?
2629
> 请更新扩展到最新版本。
2730
28-
2. 没有我需要等平台怎么办
31+
### 2. 没有我需要的平台怎么办
2932
> - 请自行开发, 我们提供详细的 API 文档和示例代码。参见 [开始开发](/docs/development)
3033
> - 请在 [GitHub Issues](https://github.com/MultiPost-Extension/MultiPost-Extension/issues) 中提出,等待社区开发
3134
> - 付费定制开发。请联系 [support@leaper.one](mailto:support@leaper.one)
35+
36+
### 3. 为什么在扩展中点击发布后,打开了目标平台,但是没有填写内容?
37+
> 1. 重试;
38+
> 2. 检查扩展版本,更新最新版本;
39+
> 3. 检查内存情况,扩展运行需要充足内存;
40+
> 4. 不要提问类似“为什么我发布不了”、“为什么我发布的内容没有显示”等问题,我们不提供此类问题解答。提问前请阅读[《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md),并提供详细的环境、版本以及错误信息;
41+
> 5. 如果以上问题都解决了,请在 [GitHub Issues](https://github.com/MultiPost-Extension/MultiPost-Extension/issues) 中提出,等待社区反馈。
42+
43+
### 4. 为什么我发布的内容没有显示?
44+
> 检查发布内容是否符合目标平台的规定;

0 commit comments

Comments
 (0)