Skip to content

Commit

Permalink
update all file lint
Browse files Browse the repository at this point in the history
  • Loading branch information
yuluo-yx committed Sep 17, 2023
1 parent 45fb1c3 commit c3a7493
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 9 deletions.
25 changes: 19 additions & 6 deletions README-zh.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Spring Cloud Alibaba 官网

## 本地环境构建项目

### 环境准备

> 如果不想在本地安装依赖组件,可参考下文 [Docker 环境运行方式](#docker-方式运行)
项目源码基于 docusaurus v2.3.1 构建,因此要编译运行本项目需确保安装 Node.js 等基础环境。
> 项目源码基于 docusaurus v2.3.1 构建,因此要编译运行本项目需确保安装 Node.js 等基础环境。
* Node.js version 16.14+
- Node.js version 16.14+

### 快速启动

Expand All @@ -26,59 +28,68 @@ localhost:3000/
2. `npm run serve`

3. 浏览器输入

```shell
localhost:3000/
```

## Docker 方式运行

无需在本地机器安装任何组件

### 本地开发

1. 构建镜像

```shell
docker build --target development -t docs:dev .
```

2. 运行容器

```shell
docker run -p 3000:3000 docs:dev
```

### 生产部署

1. 构建镜像

```shell
docker build -t sca-site:latest .
```

2. 运行容器

```shell
docker run --rm -p 3000:80 sca-site:latest
```

## i18n注意事项
## i18n 注意事项

请注意,如果您在开发模式下使用 `npm run start``npm run start-en` 启动网站,则区域语言转换功能和本地搜索功能将不起作用。请在生产模式下使用“构建并以服务启动”流程运行该程序,以启用语言环境切换和站内搜索功能。

## 如何撰写文档

### 添加一个新文档

1. 在 i18n/en-us/docusaurus-plugin-content-docs/current或i18n/zh-cn/docusaurus-plugin-content-docs/current 下添加新的 .md 文件。对应中文文件和英文文件,中英文文件名要一致。
1. 在 i18n/en-us/docusaurus-plugin-content-docs/current 或 i18n/zh-cn/docusaurus-plugin-content-docs/current 下添加新的 .md 文件。对应中文文件和英文文件,中英文文件名要一致。
2. 更新 sidebar.js,在 en-us 或 zh-cn 目录中添加一个新条目。

### 为开发人员添加新的文章

1. 在 i18n/en-us/docusaurus-plugin-content-docs/current/developers或i18n/zh-cn/docusaurus-plugin-content-docs/current/developers 下添加新的 .md 文件,文件名应该以 _dev.md 结尾。注意,后缀 _dev 是必要的。
1. 在 i18n/en-us/docusaurus-plugin-content-docs/current/developers 或 i18n/zh-cn/docusaurus-plugin-content-docs/current/developers 下添加新的 .md 文件,文件名应该以 \_dev.md 结尾。注意,后缀 \_dev 是必要的。
2. 更新 sidebar.js,在 en-us 或 zh-cn 中添加一个新条目。

### 添加一个新博客

1. 在 i18n/en-us/docusaurus-plugin-content-blog/current或i18n/zh-cn/docusaurus-plugin-content-blog/current 下添加新的 .md 文件。对应中文文件和英文文件,中英文文件名要一致。
1. 在 i18n/en-us/docusaurus-plugin-content-blog/current 或 i18n/zh-cn/docusaurus-plugin-content-blog/current 下添加新的 .md 文件。对应中文文件和英文文件,中英文文件名要一致。
2. 需要 `SEO` 配置。

## SEO

the type is :

```
---
title: title
Expand All @@ -91,10 +102,12 @@ custom_edit_url: https://github.com/spring-cloud-alibaba-group/spring-cloud-alib
```

**注意:**

1. “title” 不能包含 “:”
2. `keywords` 必须是 `Array`
3. `custom_edit_url` 是到这个 repo 中的文档的链接,必需的。

## 注意 .md 文件

1. 不要使用不正确的 html 标签,如 `<img>, <br>` ,替换为 `<img/> <br/>`
2. 如果您想显示 `<xx>` ,请替换为 `&lt;xx&gt;`
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Spring Cloud Alibaba Official Website

## Run In Local Environment

### Pre-requirements

> If requirements stated here cannot be meet in local environment, please refer to [Run with Docker](#run-with-docker).
The project source code is built based on docusaurus v2.3.1, so to compile and run this project, it is necessary to ensure the installation of Node.js and other basic environments.

* Node.js version 16.14+
- Node.js version 16.14+

### Quick Start

Expand All @@ -27,31 +29,39 @@ localhost:3000/
2. `npm run serve`

3. visit with browser

```shell
localhost:3000/
```

## Run With Docker

> No extra components needed except docker.
### Run locally

1. build image

```shell
docker build --target development -t docs:dev .
```

2. run container

```shell
docker run -p 3000:3000 docs:dev
```

### Run in production

1. build image

```shell
docker build -t sca-site:latest .
```

2. run container

```shell
docker run --rm -p 3000:80 sca-site:latest
```
Expand All @@ -69,7 +79,7 @@ Please note that if you start the site in development mode with `npm run start`

### Add new articles for developers

1. Add a new .md file under i18n/en-us/docusaurus-plugin-content-docs/current/developers or i18n/zh-cn/docusaurus-plugin-content-docs/current/developers, the file name should start with _dev.md ends. Note that the suffix _dev is necessary.
1. Add a new .md file under i18n/en-us/docusaurus-plugin-content-docs/current/developers or i18n/zh-cn/docusaurus-plugin-content-docs/current/developers, the file name should start with \_dev.md ends. Note that the suffix \_dev is necessary.
2. Update sidebar.js to add a new entry in en-us or zh-cn.

### Add a new blog
Expand All @@ -80,6 +90,7 @@ Please note that if you start the site in development mode with `npm run start`
## SEO

the type is:

```
---
title: title
Expand All @@ -92,10 +103,12 @@ custom_edit_url: https://github.com/spring-cloud-alibaba-group/spring-cloud-alib
```

**Notice:**

1. "title" cannot contain ":"
2. `keywords` must be `Array`
3. `custom_edit_url` is a link to the documentation in this repo, required.

## Note the .md file

1. Do not use incorrect html tags, such as `<img>, <br>`, replace it with `<img/> <br/>`;
2. If you want to display `<xx>`, please replace it with `&lt;xx&gt;`.
2. If you want to display `<xx>`, please replace it with `&lt;xx&gt;`.

0 comments on commit c3a7493

Please sign in to comment.