README.md 3.8 KB
Newer Older
hbcui1984's avatar
hbcui1984 已提交
1 2 3
`uni-app` 是一个使用 [Vue.js](https://vuejs.org/) 开发所有前端应用的框架,开发者编写一套代码,可发布到iOS、Android、Web(响应式)、以及各种小程序(微信/支付宝/百度/头条/QQ/快手/钉钉/淘宝)、快应用等多个平台。

官网地址:[uniapp.dcloud.io](https://uniapp.dcloud.io)
hbcui1984's avatar
hbcui1984 已提交
4 5 6 7

## 文档编写注意事项

1. 右侧导航仅支持二级、三级、四级
D
DCloud_LXH 已提交
8 9
2. 文档如有标题,必须从一级或二级开始,不允许只有三级,没有二级的情况;也不允许先有三级、后有二级的情况;
3. FAQ、注意事项、常见问题,要放在文档最下方,不要穿插在文档中间位置
D
DCloud_LXH 已提交
10
4. 容器书写方式,支持:`tip``warning``danger``details(在 IE / Edge 中不生效)` [详情](https://vuepress.vuejs.org/zh/guide/markdown.html#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%B9%E5%99%A8)
D
DCloud_LXH 已提交
11 12 13 14 15 16
    ```md
    ::: warning 注意
    - 认证凭证有效期为`30分钟`
    - 当余额全部被冻结时,会出现有余额但无法调用服务的情况
    :::
    ```
D
DCloud_LXH 已提交
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
    ![](https://web-assets.dcloud.net.cn/unidoc/zh/action_temp.jpg)
5. 代码语法高亮支持:`js``javascript``ts``typescript``objc(Objective-C)``kt(Kotlin)``cs(C#)``cpp(C++)`等。[详情](https://prismjs.com/#supported-languages)
6. 支持流程图:

        ```mermaid
        sequenceDiagram
        actor user as 用户端
        participant cf as 云函数/云对象
        participant service as 认证服务
        activate user
        user->>+user: 获取设备信息metaInfo
        user->>+cf: 提交姓名、身份证号、metaInfo获取certifyId
        cf->>+service: 提交姓名、身份证号、metaInfo获取certifyId
        service-->>-cf: 返回certifyId
        cf-->>-user: 返回certifyId
        user->>+service: 调用sdk进行刷脸认证
        service-->>-user: 返回认证结果
        user->>+cf: 请求校验认证结果
        cf->>+service: 请求认证结果
        service-->>-cf: 返回认证结果
        cf-->>-user: 返回最终实人认证结果
        deactivate user
        ```
    ![](https://web-assets.dcloud.net.cn/unidoc/zh/doc_mermaid.jpg)
7. 代码支持行高亮 [详情](https://vuepress.vuejs.org/zh/guide/markdown.html#%E4%BB%A3%E7%A0%81%E5%9D%97%E4%B8%AD%E7%9A%84%E8%A1%8C%E9%AB%98%E4%BA%AE)
D
DCloud_LXH 已提交
42

D
DCloud_LXH 已提交
43 44
    ![](https://web-assets.dcloud.net.cn/unidoc/zh/docs_code_color.jpg)
8. 标题(Badge)组件 [详情](https://vuepress.vuejs.org/zh/guide/using-vue.html#badge)
D
DCloud_LXH 已提交
45

D
DCloud_LXH 已提交
46
    ![](https://web-assets.dcloud.net.cn/unidoc/zh/docs_bage_component.jpg)
D
DCloud_LXH 已提交
47 48
9.  可使用模板语法 [详情](https://vuepress.vuejs.org/zh/guide/using-vue.html#%E6%A8%A1%E6%9D%BF%E8%AF%AD%E6%B3%95)

D
DCloud_LXH 已提交
49 50 51 52
    ![](https://web-assets.dcloud.net.cn/unidoc/zh/docs_temp_code.jpg)
10. 图片点击放大 `img.class="zooming"`
    ```html
    <img class="zooming" src="xxx">
D
DCloud_LXH 已提交
53
    ```
D
DCloud_LXH 已提交
54
11. md 支持书写属性。`#{`:左定界符,与 markdown 语法之间不能有空格;`}` 右定界符
D
DCloud_LXH 已提交
55
    ```md
D
DCloud_LXH 已提交
56
    ![](https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app-multiport.jpg)#{.zooming data=abc width=100 height=100}
D
DCloud_LXH 已提交
57 58 59 60 61 62
    ```
    渲染为:
    
    ```html
    <img src="https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app-multiport.jpg" class="zooming" data="abc" width="100" height="100" />
    ```
D
DCloud_LXH 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
## 文档 Algolia 使用限额
Included Quota:
- Records: 1,000,000
- Operations: 1,000,000

Included Features:
- Analytics Api
- Search Analytics
- Events Analytics
- 90 Days Analytics Retention
- AI Synonyms
- Dynamic Reranking

Advanced Team Management
- Crawler UI
- Query Suggestion
- Facet Display
- Natural Language Processing (NLP)
- Synonyms 10,000/index

Size Limits:
- maxRecordSize 100KB
- maximum application size 100GB
- maxNbIndices 1,000

AI Synonyms and Dynamic Reranking:need to send click events (via insights) to leverage Dynamic Reranking.