devsapp/alireadme

阿里云应用帮助文档标准化工具

使用流程：

1. 如果没有登陆 Serverless Registry，需要执行 s cli registry login 进行登录
2. 在 Serverless Devs 的应用项目目录下，执行 s cli alireadme （即与 publish.yaml 平级的路径执行）
3. 在浏览器中，可以看到帮助文档的在线编辑： 只需要在左侧进行编辑，即可实现实时预览，完成之后点击右下角的保存，即可存到 readme.md 文件。

ps：关于图床空间，每个 Serverless Registry 账号默认的图床大小为 50M，账号下应用组件下载次数每下载超过 100 次，即可获得 1M 的空间。

alireadme's Issues

alireadme 模块升级

背景

随着应用中心功能逐渐丰富，开发者需要越来越多的应用中心的提醒与告知能力，所以将会在现有的readme基础上，进行更新维护。

原型图

新版的 alireadme 将会有三个功能，分别是：

• 引导信息配置：用来配置引导信息，主要用于用户在使用之前的提醒
• 帮助文档：用于在用户查看详情时所显示的内容
• 使用文档：用于用户部署完成之后所显示的内容

对应原型图：

相关规范描述

1. 打开项目，会预制加载对应内容，以 Publish.yaml 同目录下的 readme 文件为基础，如果没有该文件，则以 src 目录下的 readme 文件为基础，进行读取；
2. 存储之后将会同时生成 Publish.yaml 同步录下一集 src 目录下两个 readme 文档；
3. 文档最终拼接结构如下：

# image-process 帮助文档

<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=${应用名称}&type=packageType">
  </a>
  <a href="http://www.devsapp.cn/details.html?name=${应用名称}" class="ml-1">
    <img src="http://editor.devsapp.cn/icon?package=${应用名称}&type=packageVersion">
  </a>
  <a href="http://www.devsapp.cn/details.html?name=${应用名称}" class="ml-1">
    <img src="http://editor.devsapp.cn/icon?package=${应用名称}&type=packageDownload">
  </a>
</p>

<description>

> ***${应用描述信息，主要是publish.yaml中的Description}***

</description>


- [ :smiley_cat:  代码](https://github.com/devsapp/image-process)
- [ :eyes:  预览](https://github.com/devsapp/image-process)


## 前期准备

使用该项目，您需要有开通以下服务：

<service>

| 服务 |  备注  |      
| --- |  --- |   
| 函数计算  |  这是为什么需要这个服务的描述 |  

</service>

推荐您拥有以下的产品权限 / 策略：

<auth>

| 服务/业务 |  权限 |  备注  |      
| --- |  --- |   --- |   
| 函数计算  | AliyunFCFullAccess |  这是为什么需要这个权限的描述  |  

</auth>

您还需要注意：

<remark>

项目注意事项

</remark>

免责声明：

<disclaimers>

免责声明内容

<disclaimers>

## 部署 & 体验

<appcenter>

-  :fire:  通过 [Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=${应用名称}) ，
[![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=${应用名称})  该应用。 

</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) ；
    - 初始化项目：`s init ${应用名称} -d ${应用名称}`   
    - 进入项目，并进行项目部署：`cd ${应用名称} && s deploy -y`

</deploy>

## 应用详情

<appdetail id="flushContent">

使用python [wand](https://docs.wand-py.org/en/0.5.6/index.html)图片处理库进行常见的图片处理：

| 功能   | 请求路径      | 参数                                                    |   
|------|-----------|-------------------------------------------------------|  
| 拼接   | /pinjie   | left=bucket/image1.jpg&right=bucket/image2.jpg        |    
| 水印   | /watermark | img=bucket/image.jpg&text=hello-fc                    |    
| 格式转换 | /format   | img=bucket/image.jpg&fmt=png                          |    
| 图片转灰 | /gray | img=bucket/image.jpg(or .png,jpeg,webp)               |
| 保存结果 | 上述参数均可    | img=bucket/image.jpg&fmt=png&target=bucket/output.png |    

</appdetail>


## 使用文档

<usedetail id="flushContent">

使用python [wand](https://docs.wand-py.org/en/0.5.6/index.html)图片处理库进行常见的图片处理：

| 功能   | 请求路径      | 参数                                                    |   
|------|-----------|-------------------------------------------------------|  
| 拼接   | /pinjie   | left=bucket/image1.jpg&right=bucket/image2.jpg        |    
| 水印   | /watermark | img=bucket/image.jpg&text=hello-fc                    |    
| 格式转换 | /format   | img=bucket/image.jpg&fmt=png                          |    
| 图片转灰 | /gray | img=bucket/image.jpg(or .png,jpeg,webp)               |
| 保存结果 | 上述参数均可    | img=bucket/image.jpg&fmt=png&target=bucket/output.png |    

</usedetail>


<devgroup>

## 开发者社区

您如果有关于错误的反馈或者未来的期待，您可以在 [Serverless Devs repo Issues](https://github.com/serverless-devs/serverless-devs/issues) 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态，您可以通过以下渠道进行：

<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> | 

</p>

</devgroup>