Rancher 文档项目教程

1. 项目目录结构及介绍

Rancher 文档项目的目录结构如下：

.
├── .github
├── .gitignore
├── .sass-lint.yml
├── Dockerfile.algolia
├── Dockerfile.build
├── Dockerfile.dev
├── Dockerfile.prod
├── Dockerfile.staging
├── LICENSE
├── README.md
├── config.toml
├── nginx.conf
├── package.json
├── pull_request_template.md
├── scripts
├── src
├── static
└── yarn.lock

以下是各个目录和文件的简要介绍：

• .github: 包含 GitHub 仓库的配置文件，例如 issue 和 pull request 模板。
• .gitignore: 指定在 Git 仓库中应该忽略的文件和目录。
• .sass-lint.yml: SASS 代码风格的配置文件。
• Dockerfile.*: 不同环境下的 Docker 构建文件，用于构建容器镜像。
• LICENSE: Apache-2.0 许可证文件。
• README.md: 项目的自述文件，包含项目的基本信息和说明。
• config.toml: 项目配置文件，用于配置网站的基本信息。
• nginx.conf: Nginx 服务器配置文件。
• package.json: Node.js 项目配置文件，包含项目依赖和脚本。
• pull_request_template.md: Pull Request 的模板文件。
• scripts: 包含项目的脚本文件，用于项目的开发和构建。
• src: 存放项目的源代码和资源文件。
• static: 存放静态文件，如 CSS、JavaScript 和图片等。
• yarn.lock: 记录项目的依赖版本。

2. 项目的启动文件介绍

项目的启动主要通过 scripts/dev 脚本文件进行。以下是启动开发环境的步骤：

• 在项目根目录下，运行 ./scripts/dev（Linux）或 .\scripts\dev-windows.ps1（Windows）。
• 脚本会启动一个本地服务器，默认端口为 9001。
• 在浏览器中访问 http://localhost:9001/，即可查看项目文档。

3. 项目的配置文件介绍

项目的配置主要通过 config.toml 文件进行。以下是一些常用配置项：

• baseURL: 网站的基本 URL，例如 "http://example.com"。
• title: 网站标题。
• description: 网站描述。
• languageCode: 网站语言代码，例如 "zh-CN"。
• theme: 使用的主题样式。

通过修改 config.toml 文件，可以定制化网站的行为和外观。