Flink-Web 项目技术文档

1. 安装指南

1.1 使用 Docker 镜像安装

要使用 Docker 镜像构建和测试 Flink 文档网站，请执行以下命令：

./docker-build.sh

构建完成后，网站将在 http://localhost:1313/ 上提供服务。

1.2 本地安装 Hugo

要在本地安装 Hugo 并构建 Flink 文档网站，请按照以下步骤操作：

1. 确保已在系统上安装了 Hugo 0.124.1 的扩展版本，支持 Sass/SCSS。
2. 执行以下命令：

./build.sh

构建完成后，网站将在 http://localhost:1313/ 上提供服务。

2. 项目的使用说明

2.1 测试本地更改

在本地测试更改时，可以使用 Docker 镜像或本地安装的 Hugo 来构建和查看网站。

使用 Docker 镜像：

./docker-build.sh

本地 Hugo 安装：

./build.sh

2.2 构建网站

在将更改合并到 asf-site 分支之前，必须重新构建网站。可以使用以下命令进行非增量构建：

使用 Docker 镜像：

./docker-build.sh build

本地 Hugo 安装：

./build.sh build

构建完成后，生成的静态 HTML 文件将位于 content 文件夹中，用于提供项目网站。

3. 项目API使用文档

3.1 Markdown 语法

Flink 文档页面使用 Markdown 编写。可以使用 GitHub 风格的 Markdown 语法 并混合使用纯 HTML。

3.2 前言

每个页面都包含一个 Jekyll 前言，用于指定页面的标题和布局。标题用作页面的顶级标题。默认布局为 plain（位于 _layouts 中）。

---
title: "页面标题"
---

3.3 页面结构

标题

所有文档都使用标题进行结构化。从这些标题中，可以自动生成页面目录。

# 一级标题  <- 用于页面标题
## 二级标题 <- 从这里开始编写内容
### 三级标题
#### 四级标题
##### 五级标题

请按照“逻辑顺序”使用标题，例如从二级标题开始，使用三级标题作为子部分等。不要使用不同的顺序，因为您不喜欢标题的外观。

目录

目录会根据标题级别 2 到 4 自动添加到每个页面。可以通过在前言中添加以下内容来省略目录：

---
bookToc: false
---

3.4 ShortCodes

Flink 使用 shortcodes 来为文档 Markdown 添加自定义功能。

4. 项目安装方式

4.1 使用 Docker 镜像

./docker-build.sh

4.2 本地安装 Hugo

./build.sh

通过以上步骤，您可以成功安装并使用 Flink-Web 项目。