Jekyll-Revealjs 项目使用教程

1. 项目目录结构及介绍

Jekyll-Revealjs 是一个基于 Jekyll 的框架，用于创建基于 Reveal.js 和 Markdown 的演示文稿。以下是项目的目录结构及其简要介绍：

jekyll-revealjs/
├── _layouts/          # 存放布局文件的目录
├── _plugins/         # 存放插件的目录
├── _posts/           # 存放文章（幻灯片）的目录
├── assets/           # 存放静态资源的目录，如 CSS、JavaScript 和图片
├── reveal.js/        # Reveal.js 的核心文件目录
├── .gitignore        # 指定 Git 忽略的文件和目录
├── .gitmodules       # 指定子模块的文件
├── Gemfile           # Ruby 依赖文件，用于定义 Jekyll 和其他 Ruby 依赖
├── LICENSE           # 项目许可证文件
├── README.md         # 项目说明文件
├── _config.yml       # Jekyll 配置文件
└── docker-compose.yml # Docker 配置文件，用于定义服务

2. 项目的启动文件介绍

要启动这个项目，你需要先安装 Jekyll。如果已经安装了 Jekyll，可以直接使用以下命令构建和预览你的演示文稿：

jekyll build

如果你没有安装 Jekyll，但是有 Docker，可以使用以下命令来构建和运行你的演示文稿：

docker-compose up

在本地预览你的演示文稿，可以运行以下命令：

jekyll serve

然后在浏览器中访问 http://localhost:4000。

3. 项目的配置文件介绍

项目的配置主要通过 _config.yml 文件进行。以下是配置文件中一些重要的配置项：

title:            # 演示文稿的标题
description:      # 演示文稿的描述
author:           # 作者名字
reveal_theme:     # Reveal.js 使用的主题
reveal_transition: # Reveal.js 使用的过渡效果
reveal_theme_path: # Reveal.js 主题的路径
reveal_notes_server: # 是否支持演讲者笔记服务器
reveal_options:   # Reveal.js 的额外选项
reveal_dependencies: # Reveal.js 的额外依赖
reveal_path:      # Reveal.js 的安装路径
extra_css:        # 额外的 CSS 文件
highlight_style_sheet: # highlight.js 的 CSS 主题
mermaid_diagrams: # 是否启用 mermaid.js 图表

确保在修改配置文件后，重新构建和预览你的演示文稿以确保配置正确应用。