{"id":19509801,"url":"https://github.com/dcloudio/unidocs-en","last_synced_at":"2025-04-26T03:32:06.182Z","repository":{"id":37405310,"uuid":"344024326","full_name":"dcloudio/unidocs-en","owner":"dcloudio","description":"A cross-platform framework using Vue.js","archived":false,"fork":false,"pushed_at":"2024-04-23T11:55:06.000Z","size":61004,"stargazers_count":10,"open_issues_count":3,"forks_count":39,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-04-23T13:45:00.752Z","etag":null,"topics":["cross-platform","javascript","ui-kit","vue3"],"latest_commit_sha":null,"homepage":"https://uniapp.dcloud.io","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dcloudio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-03-03T06:23:58.000Z","updated_at":"2024-04-24T14:08:39.164Z","dependencies_parsed_at":"2024-01-02T04:32:26.464Z","dependency_job_id":"50a93f59-3611-41e7-adfc-f3bd8e94056d","html_url":"https://github.com/dcloudio/unidocs-en","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcloudio%2Funidocs-en","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcloudio%2Funidocs-en/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcloudio%2Funidocs-en/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcloudio%2Funidocs-en/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dcloudio","download_url":"https://codeload.github.com/dcloudio/unidocs-en/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250926832,"owners_count":21509045,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cross-platform","javascript","ui-kit","vue3"],"created_at":"2024-11-10T23:13:24.619Z","updated_at":"2025-04-26T03:32:01.170Z","avatar_url":"https://github.com/dcloudio.png","language":null,"readme":"`uni-app` is a framework for developing all front-end applications using [Vue.js](https://vuejs.org/). Developers write a set of codes that can be published to iOS, Android, Web (responsive), And various MiniApp(WeChat/Alipay/Baidu/Toutiao/QQ/ Kuaishou/DingTalk/Taobao), QuickApp and other platforms.\n\nOfficial website address: [uniapp.dcloud.io](https://uniapp.dcloud.io)\n\n## 如何在本地运行查看文档\n\n1. 使用命令行工具打开文档根目录\n2. 在命令行中执行 `yarn` 安装依赖，如果没有 `yarn`，则先执行 `npm i -g yarn`\n3. 在命令行中执行 `yarn dev --no-cache`，命令运行完毕后，会显示本地可查看链接，点击或复制到浏览器查看即可\n\n## 文档编写注意事项\n\n1. 右侧导航仅支持二级、三级、四级\n2. 文档如有标题，必须从一级或二级开始，不允许只有三级，没有二级的情况；也不允许先有三级、后有二级的情况；\n3. FAQ、注意事项、常见问题，要放在文档最下方，不要穿插在文档中间位置\n4. 容器书写方式，支持：`info`、`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)：\n    ```md\n    ::: warning 注意\n    - 认证凭证有效期为`30分钟`\n    - 当余额全部被冻结时，会出现有余额但无法调用服务的情况\n    :::\n    ```\n    ![](https://web-assets.dcloud.net.cn/unidoc/zh/action_temp.jpg)\n5. 代码语法高亮支持：`js`、`javascript`、`ts`、`typescript`、`objc（Objective-C）`、`kt（Kotlin）`、`cs（C#）`、`cpp（C++）`等。[详情](https://prismjs.com/#supported-languages)\n6. 支持流程图：\n\n        ```mermaid\n        sequenceDiagram\n        actor user as 用户端\n        participant cf as 云函数/云对象\n        participant service as 认证服务\n        activate user\n        user-\u003e\u003e+user: 获取设备信息metaInfo\n        user-\u003e\u003e+cf: 提交姓名、身份证号、metaInfo获取certifyId\n        cf-\u003e\u003e+service: 提交姓名、身份证号、metaInfo获取certifyId\n        service--\u003e\u003e-cf: 返回certifyId\n        cf--\u003e\u003e-user: 返回certifyId\n        user-\u003e\u003e+service: 调用sdk进行刷脸认证\n        service--\u003e\u003e-user: 返回认证结果\n        user-\u003e\u003e+cf: 请求校验认证结果\n        cf-\u003e\u003e+service: 请求认证结果\n        service--\u003e\u003e-cf: 返回认证结果\n        cf--\u003e\u003e-user: 返回最终实人认证结果\n        deactivate user\n        ```\n    ![](https://web-assets.dcloud.net.cn/unidoc/zh/doc_mermaid.jpg)\n7. 代码支持行高亮 [详情](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)\n\n    ![](https://web-assets.dcloud.net.cn/unidoc/zh/docs_code_color.jpg)\n8. 标题（Badge）组件 [详情](https://vuepress.vuejs.org/zh/guide/using-vue.html#badge)\n\n    ![](https://web-assets.dcloud.net.cn/unidoc/zh/docs_bage_component.jpg)\n9.  可使用模板语法 [详情](https://vuepress.vuejs.org/zh/guide/using-vue.html#%E6%A8%A1%E6%9D%BF%E8%AF%AD%E6%B3%95)\n\n    ![](https://web-assets.dcloud.net.cn/unidoc/zh/docs_temp_code.jpg)\n10. 图片点击放大 `img.class=\"zooming\"`\n    ```html\n    \u003cimg class=\"zooming\" src=\"xxx\"\u003e\n    ```\n11. md 支持书写属性。`#{`：左定界符，与 markdown 语法之间不能有空格；`}` 右定界符 [详情](https://www.npmjs.com/package/markdown-it-attrs#ambiguity)\n    ```md\n    ![](https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app-multiport.jpg)#{.zooming data=abc width=100 height=100}\n    ```\n    渲染为：\n\n    ```html\n    \u003cimg src=\"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app-multiport.jpg\" class=\"zooming\" data=\"abc\" width=\"100\" height=\"100\" /\u003e\n    ```\n12. 路径注意\n    - _sidebar.md是左侧导航，其中路径写https路径，可打开新页签。如左侧导航里引用了本产品目录之外的文档，需写成这种方式\n\t- 每个产品目录下均有一个static目录，在其中提交图片视频等静态资源。引用static下的静态资源时，路径可以是\"../static\"、\"./static\"，不能写\"static/\"。\n\t- 书写文档时应注意特殊符号的编写与换行：\n    \t- `###` 下应有空行\n    \t- `内容 **加粗** 内容` 两边需要有空格\n    \t- 在书写方括号 `[]` 时要注意使用转义字符 `\\`，或者使用 `\\`\\`` 包裹，否则会被识别为链接，导致链接失效\n\n13. md 表格\n    - 行列合并\n        ```md\n        |资源分类\t\t|资源细项\t\t\t\t|售价（元）\t|\n        |:-:\t\t\t|:-:\t\t\t\t\t|:-:\t\t|\n        |云函数 #{rowspan=3}|资源使用量（GBs）\t\t|0.000110592|\n        |调用次数（万次）\t\t|0.0133\t\t|\n        |出网流量（GB）\t\t\t|0.8\t\t|\n        |云数据库 #{rowspan=3}|容量（GB/天）\t\t\t|0.07\t\t|\n        |读操作使用量（万RU）\t|0.015\t\t|\n        |写操作使用量（万RU）\t|0.05\t\t|\n        |云存储 #{rowspan=4}|容量（GB/天）\t\t\t|0.0043\t\t|\n        |下载操作次数（万次）\t|0.01\t\t|\n        |上传操作次数（万次）\t|0.01\t\t|\n        |CDN 流量（GB）\t\t\t|0.18\t\t|\n        |前端网站托管 #{rowspan=2}|容量（GB/天）\t\t\t|0.0043\t\t|\n        |流量（GB）|0.18\t\t|\n        |售价（元/月）#{colspan=2}\t|5\t\t|\n        ```\n    - 无限嵌套表格行折叠\n        ```md\n        |父Table第一列|父Table第二列\t\t\t\t|父Table第三列|\n        |:------\t\t|:-------\t\t\t\t\t|:--------|\n        |A\t\t|**B**|[C](https://www.dcloud.io/hbuilderx.html)|\n        |@|第一列|第二列\t\t\t\t|第三列\t\t\t\t|\n        |@|:------\t\t|:-------:\t|-------:\t|\n        |@|第一行\t\t|**居中**|~~markdown~~|\n        |@@| 名称 | 类型 | 必备 | 默认值 | 描述 |\n        |@@| :- | :- | :- | :- | :- |\n        |@@| D | E \\\\| F | H | - | I |\n        |@|第二行\t\t|[HBuilderX](https://www.dcloud.io/hbuilderx.html)|右对齐|\n        ```\n        ![](https://web-ext-storage.dcloud.net.cn/doc/table-expandable-row.png)\n\n## 文档 Algolia 使用限额\nIncluded Quota:\n- Records: 1,000,000\n- Operations: 1,000,000\n\nIncluded Features:\n- Analytics Api\n- Search Analytics\n- Events Analytics\n- 90 Days Analytics Retention\n- AI Synonyms\n- Dynamic Reranking\n\nAdvanced Team Management\n- Crawler UI\n- Query Suggestion\n- Facet Display\n- Natural Language Processing (NLP)\n- Synonyms 10,000/index\n\nSize Limits:\n- maxRecordSize 100KB\n- maximum application size 100GB\n- maxNbIndices 1,000\n\nAI Synonyms and Dynamic Reranking：need to send click events (via insights) to leverage Dynamic Reranking.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcloudio%2Funidocs-en","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdcloudio%2Funidocs-en","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcloudio%2Funidocs-en/lists"}