Wax 开源项目使用教程

Wax 开源项目使用教程

wax Jekyll based framework for minimal exhibitions with IIIF 🐝 项目地址: https://gitcode.com/gh_mirrors/wax4/wax

1. 项目目录结构及介绍

Wax 项目的目录结构如下：

wax/
├── _data/
├── _exhibits/
├── _includes/
├── _layouts/
├── _qatar/
├── _sass/
├── assets/
│   └── img/
├── pages/
├── search/
├── .gitignore
├── .ruby-version
├── Dockerfile
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
├── _config.yml
├── index.md
└── wax_theme.gemspec

目录介绍：

• _data/: 存放项目的数据文件。
• _exhibits/: 存放展览相关的文件。
• _includes/: 存放可重用的 HTML 片段。
• _layouts/: 存放页面布局模板。
• _qatar/: 存放与卡塔尔相关的文件（可能是特定展览或内容）。
• _sass/: 存放 SASS 样式文件。
• assets/: 存放静态资源文件，如图片等。
• pages/: 存放项目的页面文件。
• search/: 存放搜索相关的文件。
• .gitignore: Git 忽略文件配置。
• .ruby-version: Ruby 版本配置。
• Dockerfile: Docker 配置文件。
• Gemfile: Ruby 依赖管理文件。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• Rakefile: Rake 任务配置文件。
• _config.yml: Jekyll 配置文件。
• index.md: 项目首页文件。
• wax_theme.gemspec: Wax 主题的 gemspec 文件。

2. 项目启动文件介绍

Wax 项目使用 Jekyll 作为静态站点生成器。启动项目的主要命令如下：

bundle exec jekyll serve

启动步骤：

1. 安装依赖: 首先需要安装项目的 Ruby 依赖，使用以下命令：

   bundle install
   

2. 启动服务: 安装完依赖后，使用以下命令启动 Jekyll 服务：

   bundle exec jekyll serve
   

3. 访问站点: 启动服务后，可以在浏览器中访问 http://localhost:4000 查看站点。

3. 项目配置文件介绍

Wax 项目的主要配置文件是 _config.yml，该文件用于配置 Jekyll 站点的各种参数。

_config.yml 配置文件示例：

title: Wax 展览
description: 使用 Wax 框架创建的展览
baseurl: ""
url: "http://localhost:4000"

# 其他配置项...

配置项介绍：

• title: 站点的标题。
• description: 站点的描述。
• baseurl: 站点的基本 URL（通常为空字符串）。
• url: 站点的完整 URL（本地开发时通常为 http://localhost:4000）。

其他配置项：

• collections: 定义项目的集合（如展览、页面等）。
• defaults: 定义页面的默认布局和参数。
• plugins: 定义使用的 Jekyll 插件。

通过配置 _config.yml 文件，可以自定义 Wax 站点的各种行为和外观。

wax Jekyll based framework for minimal exhibitions with IIIF 🐝 项目地址: https://gitcode.com/gh_mirrors/wax4/wax