Merge pull request #14 from devsapp/fix-readme

application readme not displayed

publish.yaml

@@ -3,7 +3,7 @@ Type: Project
 Name: start-pdf2img-v3
 Provider:
   - 阿里云
-Version: 0.0.6
+Version: 0.0.7
 Description: 本案例是将 pdf 转 img的逻辑封装成一个python函数，快速创建并部署到阿里云函数计算 FC。
 HomePage: https://github.com/devsapp/start-pdf2img
 Organization: 阿里云函数计算（FC）

readme.md

@@ -1 +1,153 @@
-src/readme.md
+
+> 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。
+
+# start-pdf2img-v3 帮助文档
+
+<description>
+
+本案例是将 pdf 转 img的逻辑封装成一个python函数，快速创建并部署到阿里云函数计算 FC。
+
+</description>
+
+<codeUrl>
+
+
+
+</codeUrl>
+<preview>
+
+
+
+</preview>
+
+
+## 前期准备
+
+使用该项目，您需要有开通以下服务并拥有对应权限：
+
+<service>
+
+
+
+| 服务/业务 |  权限  | 相关文档 |
+| --- |  --- | --- |
+| 函数计算 |  AliyunFCFullAccess | [帮助文档](https://help.aliyun.com/product/2508973.html) [计费文档](https://help.aliyun.com/document_detail/2512928.html) |
+
+</service>
+
+<remark>
+
+
+
+</remark>
+
+<disclaimers>
+
+
+
+</disclaimers>
+
+## 部署 & 体验
+
+<appcenter>
+
+- :fire: 通过 [Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=start-pdf2img-v3) ，
+  [![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://fcnext.console.aliyun.com/applications/create?template=start-pdf2img-v3) 该应用。
+
+</appcenter>
+<deploy>
+
+- 通过 [Serverless Devs Cli](https://docs.serverless-devs.com/user-guide/install) 进行部署：
+  - [安装 Serverless Devs Cli 开发者工具](https://docs.serverless-devs.com/user-guide/install) ，并进行[授权信息配置]( https://docs.serverless-devs.com/user-guide/config) ；
+  - 初始化项目：`s init start-pdf2img-v3 -d start-pdf2img-v3`
+  - 进入项目，并进行项目部署：`cd start-pdf2img-v3 && s deploy -y`
+
+</deploy>
+
+## 案例介绍
+
+<appdetail id="flushContent">
+
+本案例是将 pdf 转 img的逻辑封装成一个python函数，快速创建并部署到阿里云函数计算 FC。
+
+运用了pdf2image 这一个 Python 库，专门用于将 PDF 文件转换为图像。这个库为 PDF 到图像的转换提供了简单的接口，并依赖于流行的开源软件 Poppler 工具进行实际的转换过程。
+
+主要功能：
+
+1、PDF 到图像的转换：能够将 PDF 页面转换为多种图像格式，如 JPEG、PNG 等。
+
+2、定制选项：支持多种转换参数，包括分辨率、页面范围、单页图像输出等。
+
+3、缩略图生成：快速生成 PDF 页面的缩略图。
+
+通过 Serverless 开发平台，您只需要几步，就可以体验word 转 pdf，并享受 Serverless 架构带来的降本提效的技术红利。
+
+</appdetail>
+
+## 使用流程
+
+<usedetail id="flushContent">
+
+### 查看部署的案例
+
+1、部署成功后，从资源信息栏，找到对应函数资源，点击函数名称跳转到函数计算控制台，如：
+![](https://img.alicdn.com/imgextra/i3/O1CN01llqj5j1OEHYmUMcKN_!!6000000001673-0-tps-1492-464.jpg)
+2、在代码页签，单击测试函数右侧的图标，从下拉列表中选择配置测试参数，输入如下示例测试参数，然后单击确定。
+```bash
+{
+     "bucket" : "my-bucket",
+     "region" : "cn-hangzhou",
+     "src_object" : "test.pdf",
+     "dst_object" : "test.zip"
+}
+```
+
+其中：
+
+|参数 |是否必填 |描述                      |
+|--------|----------------|---------------------------|
+| bucket | 必需 | pdf 文件所在的 bucket 名字 |
+| region | 可选 | pdf 文件所在的 bucket 的 region, 不填默认使用函数所在的 region |
+| src_object | 必需 | pdf 文件所在的 bucket 中的 object key |
+| src_object | 必需 | 必须是 .zip 结尾, pdf 文件转成图片后的 zip 包所在的 object key |
+
+3、单击测试函数，函数执行成功后，查看返回结果。
+
+```bash
+ SUCC
+```
+如果您需要使用 SDK 调用这个函数， 可以参考  [OpenAPI](https://next.api.aliyun.com/api/FC) 
+
+您也可以使用 s 工具或者 SDK 调用函数，函数执行成功后， 就可以在 OSS 指定目标目录中得到一个 zip 包， zip 包里面是 pdf 每页截图的 jpg 文件
+
+```bash
+$ s invoke -e '{"bucket": "my-bucket", "region": "cn-hangzhou", "src_object": "test.pdf",  "dst_object": "test.zip"}'
+```
+
+
+### 二次开发
+
+您可以通过云端控制台的开发功能进行二次开发。如果您之前是在本地创建的项目案例，也可以在本地项目目录`start-pdf2img-v3`文件夹下，对项目进行二次开发。开发完成后，可以通过`s deploy`进行快速部署。
+
+</usedetail>
+
+## 注意事项
+
+<matters id="flushContent">
+</matters>
+
+
+<devgroup>
+
+
+## 开发者社区
+
+您如果有关于错误的反馈或者未来的期待，您可以在 [Serverless Devs repo Issues](https://github.com/serverless-devs/serverless-devs/issues) 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态，您可以通过以下渠道进行：
+
+<p align="center">  
+
+| <img src="https://img.alicdn.com/imgextra/i2/O1CN010Sk7sv1Xl6WuOb6uU_!!6000000002963-0-tps-666-662.jpg" width="130px" > | <img src="https://img.alicdn.com/imgextra/i4/O1CN010Vt5aw27VN5rJIguB_!!6000000007802-0-tps-668-630.jpg" width="130px" > |
+| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| <center>微信公众号：`serverless`</center>                                                                                         | <center>钉钉交流群：`33947367`</center>                                                                                           |
+</p>
+</devgroup>

src/readme.md

@@ -2,17 +2,6 @@
 > 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。
 
 # start-pdf2img-v3 帮助文档
-<p align="center" class="flex justify-center">
-    <a href="https://www.serverless-devs.com" class="ml-1">
-    <img src="http://editor.devsapp.cn/icon?package=start-pdf2img-v3&type=packageType">
-  </a>
-  <a href="http://www.devsapp.cn/details.html?name=start-pdf2img-v3" class="ml-1">
-    <img src="http://editor.devsapp.cn/icon?package=start-pdf2img-v3&type=packageVersion">
-  </a>
-  <a href="http://www.devsapp.cn/details.html?name=start-pdf2img-v3" class="ml-1">
-    <img src="http://editor.devsapp.cn/icon?package=start-pdf2img-v3&type=packageDownload">
-  </a>
-</p>
 
 <description>
 
@@ -22,7 +11,7 @@
 
 <codeUrl>
 
-- [:smiley_cat: 代码](https://github.com/devsapp/start-pdf2img/tree/V3)
+
 
 </codeUrl>
 <preview>
@@ -68,8 +57,8 @@
 </appcenter>
 <deploy>
 
-- 通过 [Serverless Devs Cli](https://www.serverless-devs.com/serverless-devs/install) 进行部署：
-  - [安装 Serverless Devs Cli 开发者工具](https://www.serverless-devs.com/serverless-devs/install) ，并进行[授权信息配置](https://docs.serverless-devs.com/fc/config) ；
+- 通过 [Serverless Devs Cli](https://docs.serverless-devs.com/user-guide/install) 进行部署：
+  - [安装 Serverless Devs Cli 开发者工具](https://docs.serverless-devs.com/user-guide/install) ，并进行[授权信息配置]( https://docs.serverless-devs.com/user-guide/config) ；
   - 初始化项目：`s init start-pdf2img-v3 -d start-pdf2img-v3`
   - 进入项目，并进行项目部署：`cd start-pdf2img-v3 && s deploy -y`
 
@@ -157,8 +146,8 @@ $ s invoke -e '{"bucket": "my-bucket", "region": "cn-hangzhou", "src_object": "t
 
 <p align="center">  
 
-| <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407298906_20211028074819117230.png" width="130px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407044136_20211028074404326599.png" width="130px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407252200_20211028074732517533.png" width="130px" > |
-| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
-| <center>微信公众号：`serverless`</center>                                                                                         | <center>微信小助手：`xiaojiangwh`</center>                                                                                        | <center>钉钉交流群：`33947367`</center>                                                                                           |
+| <img src="https://img.alicdn.com/imgextra/i2/O1CN010Sk7sv1Xl6WuOb6uU_!!6000000002963-0-tps-666-662.jpg" width="130px" > | <img src="https://img.alicdn.com/imgextra/i4/O1CN010Vt5aw27VN5rJIguB_!!6000000007802-0-tps-668-630.jpg" width="130px" > |
+| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| <center>微信公众号：`serverless`</center>                                                                                         | <center>钉钉交流群：`33947367`</center>                                                                                           |
 </p>
 </devgroup>