Apache Amoro 项目使用文档

Apache Amoro 项目使用文档

amoro-siteDocumentation site for project Amoro项目地址:https://gitcode.com/gh_mirrors/am/amoro-site

1. 项目的目录结构及介绍

Apache Amoro 项目的目录结构如下：

amoro-site/
├── amoro-docs/
│   ├── content/
│   └── ...
├── amoro-theme/
├── github/
│   └── workflows/
├── .gitignore
├── .asf.yaml
├── DISCLAIMER
├── LICENSE
├── NOTICE
├── README.md
└── ...

目录结构介绍

• amoro-docs/: 包含文档站点的内容。
  • content/: 存放具体文档内容。
• amoro-theme/: 包含站点的主题文件。
• github/: 包含 GitHub 工作流配置。
  • workflows/: 存放 GitHub Actions 的工作流配置文件。
• .gitignore: Git 忽略文件配置。
• .asf.yaml: Apache 软件基金会配置文件。
• DISCLAIMER: 免责声明。
• LICENSE: 许可证文件。
• NOTICE: 版权声明。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

启动站点页面

要启动站点页面，请执行以下命令：

(cd amoro-site && hugo serve)

启动文档站点

要启动文档站点，请执行以下命令：

(cd amoro-docs && hugo serve)

3. 项目的配置文件介绍

.asf.yaml

该文件用于配置 Apache 软件基金会的相关设置。

config.toml

在 amoro-site 和 amoro-docs 目录中，config.toml 文件用于配置 Hugo 站点的设置，包括站点标题、主题、菜单等。

github/workflows

该目录下的文件用于配置 GitHub Actions 的工作流，自动化项目的构建、测试和部署过程。

以上是 Apache Amoro 项目的基本使用文档，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助您更好地理解和使用该项目。

amoro-siteDocumentation site for project Amoro项目地址:https://gitcode.com/gh_mirrors/am/amoro-site