Skip to content

Commit

Permalink
Update docs titles and descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
wangxiao committed Aug 29, 2023
1 parent 3fe7e30 commit 7dcdf3e
Show file tree
Hide file tree
Showing 56 changed files with 262 additions and 481 deletions.
5 changes: 5 additions & 0 deletions docs/en/src/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: About AirCode | AirCode Docs
description: AirCode is an online platform designed to streamline the development and deployment of Node.js applications, tailored for full-stack engineers.
---

# About AirCode {#intro}

AirCode is an online platform designed to streamline the development and deployment of Node.js applications, tailored for full-stack engineers.
Expand Down
5 changes: 5 additions & 0 deletions docs/en/src/reference/server/database-api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Database API | AirCode Docs
description: This article shows all API descriptions and examples under `aircode.db`.
---

# Database API {#api}

This article shows all API descriptions and examples under `aircode.db`.
Expand Down
5 changes: 5 additions & 0 deletions docs/en/src/reference/server/files-api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: File Storage API | AirCode Docs
description: This article shows all API descriptions and examples under `aircode.files`.
---

# File Storage API {#api}

This article shows all API descriptions and examples under `aircode.files`.
Expand Down
5 changes: 5 additions & 0 deletions docs/en/src/reference/server/functions-api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Function API | AirCode Docs
description: This article shows all API descriptions and examples about Function API.
---

# Function API {#intro}

[[toc]]
Expand Down
5 changes: 5 additions & 0 deletions docs/en/src/reference/server/functions-runtime.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Function Runtime | AirCode Docs
description: The AirCode runtime is Node.js, which supports writing and executing server-side code using JavaScript.
---

# Function Runtime {#intro}

The AirCode runtime is Node.js, which supports writing and executing server-side code using JavaScript.
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/about/extensions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 增强功能 | AirCode 文档
description: 官方和开源社区提供了一系列扩展来增强 AirCode 的功能。
---

# 增强功能 {#intro}

官方和开源社区提供了一系列扩展来增强 AirCode 的功能。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/about/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 常见问题 | AirCode 文档
description: 我们收集了很多常见问题,希望可以快速帮助到你
---

# 常见问题 {#faq}

[[toc]]
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/about/limits.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 资源限制 | AirCode 文档
description: 为了避免资源滥用,确保平台的稳定性,AirCode 中每一个账号及应用均拥有相应的资源限制,超出限制可能会导致调用或部署失败。
---

# 资源限制 {#intro}

为了避免资源滥用,确保平台的稳定性,AirCode 中每一个账号及应用均拥有相应的资源限制,超出限制可能会导致调用或部署失败。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/careers/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 加入我们 | AirCode 文档
description: 我们在打造面向全球开发者的新一代 Node.js 云服务产品 AirCode([https://aircode.io](https://aircode.io)),已获得国际顶级 VC 数百万美元天使轮投资。
---

# 加入我们

## 关于 AirCode
Expand Down
2 changes: 2 additions & 0 deletions docs/zh-cn/src/chatgpt/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
aside: false
title: 5 分钟用 JavaScript 接入 ChatGPT 手把手教程 | AirCode 文档
description: 仅需 5 分钟,快速开发一个 ChatGPT 机器人,下面为全部教程。
---

# 5 分钟用 JavaScript 接入 ChatGPT 手把手教程
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/errors/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 错误索引 | AirCode 文档
description:
---

# 错误索引

This doc is WORK IN PROGRESS. It is expected to be published in early February, 2023.
5 changes: 5 additions & 0 deletions docs/zh-cn/src/getting-started/database.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 数据库入门 | AirCode 文档
description: AirCode 提供了一套开箱即用的数据库功能,只需使用 `aircode.db` 即可在云函数中对数据进行存取操作。
---

# 数据库入门 {#intro}

AirCode 提供了一套开箱即用的数据库功能,只需使用 `aircode.db` 即可在云函数中对数据进行存取操作。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/getting-started/files.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 文件存储入门 | AirCode 文档
description: 在 AirCode 中上传和管理文件是非常简单的,通过 `aircode.files` 的接口一行代码即可实现,并且每个上传的文件都会自带一个 CDN 加速的访问地址。
---

# 文件存储入门 {#intro}

在 AirCode 中上传和管理文件是非常简单的,通过 `aircode.files` 的接口一行代码即可实现,并且每个上传的文件都会自带一个 CDN 加速的访问地址。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/database/delete.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 删除数据 | AirCode 文档
description: AirCode 提供了一套开箱即用的数据库功能,只需使用 `aircode.db` 即可在云函数中对数据进行存取操作。
---

# 删除数据 {#intro}

AirCode 提供两种方法来删除数据:
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/database/find.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 查询数据 | AirCode 文档
description: AirCode 的数据库支持传入不同的条件来查询数据,并且对查询结果进行处理。
---

# 查询数据 {#intro}

AirCode 的数据库支持传入不同的条件来查询数据,并且对查询结果进行处理。本文档将通过示例说明如何通过 `aircode.db` 在云函数中执行查询,包括:
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/database/geo.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 基于地理位置查询 | AirCode 文档
description: AirCode 数据库支持存储地理位置数据,并基于地理位置来实现查询。这可以让你快速实现类似查找附近的饭店、查找一个区域内的景点等操作。
---

# 基于地理位置查询 {#intro}

AirCode 数据库支持存储地理位置数据,并基于地理位置来实现查询。这可以让你快速实现类似查找附近的饭店、查找一个区域内的景点等操作。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/database/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 数据库概览 | AirCode 文档
description: AirCode 提供了开箱即用的数据库,无需单独购买、配置和连接,在云函数中通过 `aircode.db` 即可直接访问和操作。
---

# 数据库概览 {#intro}

AirCode 提供了开箱即用的数据库,无需单独购买、配置和连接,在云函数中通过 `aircode.db` 即可直接访问和操作。例如:
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/database/indexes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 使用索引优化查询 | AirCode 文档
description: 通过在数据库中建立索引,可以让数据库在查询时直接检索到对应字段,从而显著提升查询效率。
---

# 使用索引优化查询 {#use-indexes}

通过在数据库中建立索引,可以让数据库在查询时直接检索到对应字段,从而显著提升查询效率。如果没有索引,即使最简单的查询也需要扫描表中的每一条记录,当数据量庞大时还会因为触发慢查询而导致操作失败。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/database/insert.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 插入数据 | AirCode 文档
description: AirCode 提供了一套开箱即用的数据库功能,只需使用 `aircode.db` 即可在云函数中对数据进行存取操作。
---

# 插入数据 {#intro}

- 通过 `aircode.db.table(tableName)` 获取要插入数据的数据表
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/database/update.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 更新数据 | AirCode 文档
description: AirCode 提供了一套开箱即用的数据库功能,只需使用 `aircode.db` 即可在云函数中对数据进行存取操作。
---

# 更新数据 {#intro}

AirCode 提供两种方法来更新数据:
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/database/web-management.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 在网页中管理数据 | AirCode 文档
description: AirCode 提供了一套开箱即用的数据库功能,只需使用 `aircode.db` 即可在云函数中对数据进行存取操作。
---

# 在网页中管理数据

This doc is WORK IN PROGRESS. It is expected to be published in early February, 2023.
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/files/delete.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 删除文件 | AirCode 文档
description: 在 AirCode 中上传和管理文件是非常简单的,通过 `aircode.files` 的接口一行代码即可实现,并且每个上传的文件都会自带一个 CDN 加速的访问地址。
---

# 删除文件 {#intro}

通过 `await aircode.files.delete(file | arrayOfFile)` 将一个或多个文件从云端删除,同时也会刷新 CDN 将相关数据移除。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/files/download.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 下载文件 | AirCode 文档
description: 在 AirCode 中上传和管理文件是非常简单的,通过 `aircode.files` 的接口一行代码即可实现,并且每个上传的文件都会自带一个 CDN 加速的访问地址。
---

# 下载文件 {#intro}

- 在云函数中,通过 `await aircode.files.download(file, [options])` 下载文件
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/files/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 文件存储概览 | AirCode 文档
description: 在 AirCode 中上传和管理文件是非常简单的,通过 `aircode.files` 的接口一行代码即可实现,并且每个上传的文件都会自带一个 CDN 加速的访问地址。
---

# 文件存储概览 {#intro}

AirCode 提供了一套极致简单的文件存储系统,一行代码即可上传文件并获得一个 CDN 加速的访问地址。例如:
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/files/upload.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 上传文件 | AirCode 文档
description: 在 AirCode 中上传和管理文件是非常简单的,通过 `aircode.files` 的接口一行代码即可实现,并且每个上传的文件都会自带一个 CDN 加速的访问地址。
---

# 上传文件 {#intro}

在云函数中通过 `await aircode.files.upload(content, [name], [options])` 上传文件到云端,并获得一个 CDN 加速的访问地址。例如:
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/debug.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 在线调试云函数 | AirCode 文档
description: 调试时开发中必不可少的部分。我们提供了一套方便和易用的在线调试工具,帮助你快速获取开发中函数的运行结果,高效迭代。
---

# 在线调试云函数 {#intro}

调试时开发中必不可少的部分。我们提供了一套方便和易用的在线调试工具,帮助你快速获取开发中函数的运行结果,高效迭代。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/deployment.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 部署云函数 | AirCode 文档
description: 云函数需要部署到线上后才能在真实环境中被访问,若对函数内容进行了修改,也需要部署后才能生效。在 AirCode 中,整个部署操作只需点击一个按钮即可完成。
---

# 部署云函数 {#intro}

云函数需要部署到线上后才能在真实环境中被访问,若对函数内容进行了修改,也需要部署后才能生效。在 AirCode 中,整个部署操作只需点击一个按钮即可完成。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/development.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 在线开发云函数 | AirCode 文档
description: AirCode 提供了一个 WebIDE,让云函数的开发过程完全在线完成,无需下载任何软件和配置。
---

# 在线开发云函数 {#intro}

AirCode 提供了一个 WebIDE,让云函数的开发过程完全在线完成,无需下载任何软件和配置。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/env.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 使用环境变量 | AirCode 文档
description: AirCode 支持在线设置和修改环境变量,并在云函数中通过 `process.env` 进行访问。
---

# 使用环境变量 {#intro}

AirCode 支持在线设置和修改环境变量,并在云函数中通过 `process.env` 进行访问。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/esm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: ESM 支持 | AirCode 文档
description: AirCode 支持 Node.js 的 ECMAScript 模块 (ESM),你可以在 `.mjs` 后缀名的文件中直接使用 ESM 语法。
---

# ESM 支持 {#intro}

AirCode 支持 Node.js 的 ECMAScript 模块 (ESM),你可以在 `.mjs` 后缀名的文件中直接使用 ESM 语法。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/fs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 读写本地文件 | AirCode 文档
description:
---

# 读写本地文件

This doc is WORK IN PROGRESS. It is expected to be published in early February, 2023.
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/get-params.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 获取 GET 参数 | AirCode 文档
description: 推荐使用 POST 方法来调用云函数,因为这样能传递多样的数据类型和更大的数据量。
---

# 获取 GET 参数 {#intro}

我们推荐使用 POST 方法来调用云函数,因为这样能传递多样的数据类型和更大的数据量。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/http-request.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 获取 GET 参数 | AirCode 文档
description: 在 AirCode 的云函数中,可以使用 HTTP 库发送 HTTP 请求,如使用 axios。
---

# 发送 HTTP 请求 {#intro}

在 AirCode 的云函数中,可以使用 HTTP 库发送 HTTP 请求,例如 [axios](https://axios-http.com/)。请注意发送 HTTP 请求是一个异步操作,需要使用 `await` 来等待其完成。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 云函数概览 | AirCode 文档
description: 云函数是 AirCode 的基本组成单元。通过我们提供的 WebIDE,让你无需关心基础设施搭建、环境配置和线上运维等繁琐之事,打开网页即可在线编写 Node.js 代码,调试并上线为可直接访问的后端接口。
---

# 云函数概览 {#intro}

云函数是 AirCode 的基本组成单元。通过我们提供的 WebIDE,让你无需关心基础设施搭建、环境配置和线上运维等繁琐之事,打开网页即可在线编写 Node.js 代码,调试并上线为可直接访问的后端接口。这些接口可方便地用于为前端提供数据、用户校验、Slack 机器人、Webhook 等等业务。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/invoke.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 调用云函数 | AirCode 文档
description: 通过我们提供的 WebIDE,让你无需关心基础设施搭建、环境配置和线上运维等繁琐之事,打开网页即可在线编写 Node.js 代码,调试并上线为可直接访问的后端接口。
---

# 调用云函数 {#intro}

线上云函数可以通过 HTTP 进行调用。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/logs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 线上日志 | AirCode 文档
description: 在云函数中可以通过 `console.log` 产生日志。
---

# 线上日志 {#intro}

在云函数中可以通过 `console.log` 产生日志。当函数部署到线上后,访问所产生的日志可以在功能区的 **Logs** 标签页中查看,并且可以使用通过日期、关键词来过滤。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/npm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 使用 NPM 安装依赖 | AirCode 文档
description: AirCode 提供了一种可视化的在线 NPM 依赖管理方法,搜索、安装、升级和卸载包,所有操作都通过在线点击完成,无需输入任何命令。
---

# 使用 NPM 安装依赖 {#intro}

AirCode 提供了一种可视化的在线 NPM 依赖管理方法,搜索、安装、升级和卸载包,所有操作都通过在线点击完成,无需输入任何命令。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/post-params.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 获取 POST 参数 | AirCode 文档
description: 当使用 POST 请求调用云函数时,HTTP Request Body 会被转化为对应云函数中的 `params` 变量,方便开发者获取和使用。
---

# 获取 POST 参数 {#intro}

当使用 POST 请求调用云函数时,HTTP Request Body 会被转化为对应云函数中的 `params` 变量,方便开发者获取和使用。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/private.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 私有函数 | AirCode 文档
description:
---

# 私有函数

This doc is WORK IN PROGRESS. It is expected to be published in early February, 2023.
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/recycle.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 函数回收站 | AirCode 文档
description:
---

# 函数回收站

This doc is WORK IN PROGRESS. It is expected to be published in early February, 2023.
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/request-header-and-method.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 获取请求头和方法 | AirCode 文档
description:
---

# 获取请求头和方法

This doc is WORK IN PROGRESS. It is expected to be published in early February, 2023.
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/require.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 函数间引用 | AirCode 文档
description: 同一个应用中的不同函数可以直接通过 `require` 相互引用。
---

# 函数间引用 {#intro}

同一个应用中的不同函数可以直接通过 `require` 相互引用。
Expand Down
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/response-header-and-code.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 设置返回头和状态码 | AirCode 文档
description:
---

# 设置返回头和状态码

This doc is WORK IN PROGRESS. It is expected to be published in early February, 2023.
5 changes: 5 additions & 0 deletions docs/zh-cn/src/guide/functions/schedule-jobs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 定时任务 | AirCode 文档
description:
---

# 定时任务

This doc is WORK IN PROGRESS. It is expected to be published in early February, 2023.
Loading

0 comments on commit 7dcdf3e

Please sign in to comment.