幻灯片

在终端中展示幻灯片。

安装

MacOS

brew install slides

Arch

yay -S slides

Nixpkgs (不稳定版)

nix-env -iA nixpkgs.slides

任何运行 `snapd` 的 Linux 发行版

sudo snap install slides

Go

go install github.com/maaslalani/slides@latest

从源码安装:

git clone https://github.com/maaslalani/slides.git
cd slides
go install

你也可以从发布页面下载二进制文件。

</details>

使用方法

创建一个包含幻灯片内容的简单 markdown 文件：

# 欢迎使用幻灯片
一个基于终端的演示工具

---

## 一切皆为 markdown
事实上，整个演示文稿都是一个 markdown 文件。

---

## 一切都在你的终端中进行
无需离开终端即可创建幻灯片并进行演示。

---

## 代码执行
```go
package main

import "fmt"

func main() {
  fmt.Println("直接在幻灯片中执行代码")
}
```

你可以通过按下 `<C-e>` 在幻灯片中执行代码，
命令的输出将显示在当前幻灯片的末尾。

---

## 预处理幻灯片

你可以添加一个由三个波浪线（`~`）包围的代码块，并编写一个在显示幻灯片之前运行的命令，
代码块内的文本将作为 `stdin` 传递给命令，
代码块将被替换为命令的 `stdout`。

```
~~~graph-easy --as=boxart
[ A ] - to -> [ B ]
~~~
```

上面的内容将被预处理成这样：

┌───┐  to   ┌───┐
│ A │ ────> │ B │
└───┘       └───┘

出于安全考虑，你必须传递一个具有执行权限的文件，
才能对幻灯片进行预处理。你可以使用 `chmod` 添加这些权限。

```bash
chmod +x file.md
```

查看示例幻灯片。

然后，要进行演示，运行：

slides presentation.md

如果提供了文件名，slides 将自动检测文件的变化并实时更新演示。

slides 也接受通过 stdin 输入：

curl http://example.com/slides.md | slides

使用以下按键序列跳转到第一张幻灯片：

<kbd>g</kbd> <kbd>g</kbd>

使用以下任一按键序列跳转到下一张幻灯片：

<kbd>空格</kbd>
<kbd>右箭头</kbd>
<kbd>下箭头</kbd>
<kbd>回车</kbd>
<kbd>n</kbd>
<kbd>j</kbd>
<kbd>l</kbd>
<kbd>Page Down</kbd>
数字 + 以上任一按键（前进 n 张幻灯片）使用以下任一键序列转到上一张幻灯片：
<kbd>左箭头</kbd>
<kbd>上箭头</kbd>
<kbd>p</kbd>
<kbd>h</kbd>
<kbd>k</kbd>
<kbd>N</kbd>
<kbd>Page Up</kbd>
数字 + 上述任一键（回退n张幻灯片）

使用以下键序列转到特定幻灯片：

数字 + <kbd>G</kbd>

使用以下键转到最后一张幻灯片：

<kbd>G</kbd>

搜索

要快速跳转到正确的幻灯片，你可以使用搜索功能。

按<kbd>/</kbd>，输入搜索词并按<kbd>Enter</kbd>
（搜索词被解释为正则表达式。/i标志使搜索不区分大小写。）

搜索后按<kbd>ctrl+n</kbd>转到下一个搜索结果。

代码执行

如果幻灯片在当前页面上找到代码块，它可以执行该代码块并在屏幕上显示结果作为虚拟文本。

在含有代码块的幻灯片上按<kbd>ctrl+e</kbd>来执行并显示结果。

预处理

你可以添加一个由三个波浪线（~）包围的代码块，并写入在显示幻灯片之前运行的命令。代码块内的文本将作为stdin传递给命令，代码块将被命令的stdout替换。用三个反引号包裹预处理后的块以保持正确的格式和换行。

```
~~~graph-easy --as=boxart
[ A ] - to -> [ B ]
~~~
```

上述内容将被预处理成如下形式：

┌───┐  to   ┌───┐
│ A │ ────> │ B │
└───┘       └───┘

出于安全考虑，你必须传递一个具有执行权限的文件才能预处理幻灯片。你可以使用chmod添加这些权限。

chmod +x file.md

配置

slides允许你通过在slides.md顶部添加元数据来自定义演示文稿的外观和感觉。

此部分完全可选，如果省略此部分或部分中的任何字段，slides将使用合理的默认值。

---
theme: ./path/to/theme.json
author: Gopher
date: MMMM dd, YYYY
paging: Slide %d / %d
---

theme：包含glamour主题的json文件路径，也可以是slides在演示前将获取的远程json文件链接。
author：在演示视图左下角显示的字符串。默认为操作系统当前用户的全名。可以为空以隐藏作者。
date：用于格式化今天日期的字符串，格式为YYYY-MM-DD。如果日期格式无效，将直接显示该字符串。默认为YYYY-MM-DD。
paging：包含0个或多个%d指令的字符串。第一个%d将被替换为当前幻灯片编号，第二个%d将被替换为幻灯片总数。默认为Slide %d / %d。如果分页值以%开头，需要用引号将其括起来。