Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix docs typos #1102

Merged
merged 5 commits into from
May 6, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: docs typos
  • Loading branch information
hai-x committed Apr 28, 2023
commit 0b2a5e52c3645ab1e12164828e01a0143f9a9f57
14 changes: 7 additions & 7 deletions docs/guide/function/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ title: 云函数入门

`Laf云函数`是运行在云端的 `JavaScript` 代码。

云函数可使用 `Typescript/JavaScript` 编写,无需管理服务器,在Web开发控制台在线编写、在线调试、一键保存即可运行后端代码。
云函数可使用 `Typescript/JavaScript` 编写,无需管理服务器,在 Web 开发控制台在线编写、在线调试、一键保存即可运行后端代码。

可在无需购买和管理服务器的情况下,快速开发后端代码。并且自带数据库和对象存储,极大降低后端开发难度。

每个云函数都是一个单独的 `Typescript` 文件,Laf为云函数单独封装了 `@lafjs/cloud` 模块,以便于更加方便的编写云函数。
每个云函数都是一个单独的 `Typescript` 文件,Laf 为云函数单独封装了 `@lafjs/cloud` 模块,以便于更加方便的编写云函数。

## 创建云函数

创建并进入 Laf 应用后,点击页面左上角「函数」按钮,点击加号,添加云函数
创建并进入 Laf 应用后,点击页面左上角「函数」按钮,点击加号添加云函数

![create-function](/doc-images/create-function.png)

**函数名** : 一般以字母或_开头,可使用`字母 数字 - _`四种,函数名不可重复
**函数名** : 一般以字母或\_开头,可使用`字母 数字 - _`四种,函数名不可重复

**标签** : 用来分类管理的,可通过标签名筛选云函数,可为每个云函数设置多个标签

Expand All @@ -32,17 +32,17 @@ title: 云函数入门

## 编辑云函数

Laf自带 `Web IDE`,可直接在浏览器在线编辑、运行(调试)、发布云函数
Laf 自带 `Web IDE`,可直接在浏览器在线编辑、运行(调试)、发布云函数

![edit-cloudfunction](/doc-images/edit-cloudfunction.png)

## 运行云函数

云函数编写后可直接运行调试,未发布的云函数也可以在此进行运行调试
云函数编写后可直接运行调试未发布的云函数也可以在此进行运行调试

![run-cloudfunction](/doc-images/run-cloudfunction.png)

如在云函数中添加 `console.log` 打印日志的代码,运行后也会直接显示在Console控制台,同时也会将云函数的返回值打印在运行结果中。
如在云函数中添加 `console.log` 打印日志的代码,运行后也会直接显示在 Console 控制台,同时也会将云函数的返回值打印在运行结果中。

可切换请求方式以及配置请求参数,默认是 `GET` 请求,此处显示的请求方式与勾选的请求方式有关。

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/oss/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: 云存储简介

# {{ $frontmatter.title }}

`laf` 云存储是基于 [MinIO](https://min.io/) 提供的对象存储服务,提供了具完全 MinIO 的对象存储服务,同时也是标准的 s3 接口,同时阿里云、腾讯云等的对象存储 都是 s3 api 兼容的,我们可以通过 s3 api 来控制文件的增删改查
`laf` 云存储是基于 [MinIO](https://min.io/) 提供的对象存储服务,提供了具完全 MinIO 的对象存储服务,同时也是标准的 s3 接口,同时阿里云、腾讯云等的对象存储都是 s3 api 兼容的,我们可以通过 s3 api 来控制文件的增删改查

## 创建 bucket

Expand Down
16 changes: 8 additions & 8 deletions docs/guide/website-hosting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ title: 静态网站托管介绍

### 上传文件,开启网站托管

上传前端项目编译后的文件到刚刚新建的云存储中
上传前端项目编译后的文件到刚刚新建的云存储中

::: tip
大部分前端项目编译完的代码都在 `dist` 文件夹中,需要将 `dist` 文件夹中的文件全部上传到云存储中
Expand Down Expand Up @@ -65,15 +65,15 @@ name: Build
on:
push:
branches:
- '*'
- "*"

env:
BUCKET_NAME: ${{ secrets.DOC_BUCKET_NAME }}
LAF_APPID: ${{ secrets.LAF_APPID }}
LAF_PAT: ${{ secrets.LAF_PAT }}
API_URL: 'https://api.laf.dev'
API_URL: "https://api.laf.dev"
WEB_PATH: .
DIST_PATH: 'dist'
DIST_PATH: "dist"
jobs:
build:
runs-on: ubuntu-latest
Expand All @@ -82,21 +82,21 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: "16.x"
# 安装项目依赖
- name: Install Dependencies
working-directory: ${{ env.WEB_PATH }}
run: npm install
# 编译项目
- name: Build
- name: Build
working-directory: ${{ env.WEB_PATH }}
run: npm run build
# 安装 laf-cli
- name: Install Laf-CLI
run: npm i laf-cli -g
# 登录 laf api
- name: Login laf-cli
working-directory: ${{ env.WEB_PATH }}
working-directory: ${{ env.WEB_PATH }}
run: laf login -r ${{ env.API_URL }} $LAF_PAT
# 初始化 Laf 应用然后将编译好的代码推送到云存储
- name: Init appid and push
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ features:
- title: 在线编程 IDE
details: 支持 AI 生成云函数,码中生花。支持全类型智能提示,在线编写、调试、日志,代码即内容。随时随地,发布上线。
- title: 触发器
details: 云函数可配置定时器和事件触发器,其中可监听数据库变更事件,数据变更可触发云函数的执行(事件触发器稍晚更新)
details: 云函数可配置定时器和事件触发器,其中可监听数据库变更事件,数据变更可触发云函数的执行(事件触发器稍晚更新)
- title: 云存储
details: 提供专业兼容 S3 标准的对象存储服务(MinIO),支持 Service Account 开放能力。
- title: 静态网站托管
Expand Down