Unveil Rs

Unveil Rs 是一个从 Markdown 文件创建演示文稿的工具。它受到 reveal.js , mdbook 和 zola 的启发。

它看起来像什么？

查看 实时演示。

安装

1. 从 crates.io

目前 unveil 只在 crates.io 上可用。

要开始，您需要安装 rust，然后在终端中输入以下命令

cargo install unveil-rs --version=0.1.0-aplha>

注意：当 unveil 版本仍处于 alpha 状态时，需要 --version 标志。

2. 从 git

如果您想获取最新版本，可以运行

cargo install --git https://github.com/oknozor/unveil-rs.git unveil-rs

用法

初始化

要初始化一个空项目，请运行

unveil init mypresentation

这将创建以下目录结构

├── slides
│   └── landing.md
└── unveil.toml

构建和运行

要构建您的项目，请运行

cd mypresentation && unveil build

此命令生成以下文件

├── public
│   ├── fontawesome
│   │   ├── css
│   │   │   └── fontawesome.css
│   │   └── webfonts
│   │       ├── (...)
│   ├── clipboard.js
│   ├── highlight.css
│   ├── highlight.js
│   ├── index.html
│   ├── livereload.js
│   ├── unveil.css
│   └── unveil.js
│   └── user_css.css
├── slides
│   └── landing.md
└── unveil.toml

实际上，构建命令是可选的，您可以直接在项目根目录中运行 unveil serve。这将构建静态站点并在 localhost:7878 上提供它。

从此时起，您可以开始编辑您的 Markdown 幻灯片。当您编辑时，网站将重新加载。

添加新幻灯片

要添加幻灯片，请在项目根目录中运行 unveil new myslide。它将在 slides/ 目录中创建一个新的 Markdown 文件 myslide.md 并在 unveil.toml 配置文件中添加幻灯片条目。

name = "mypresentation"
language = "EN"
gitignore = true
slides = ["landing.md", "myslide.md"]

为您的幻灯片添加样式

受 zola 的 frontmatter 启发，unveil 幻灯片可以使用样式主题块进行样式化。Sass 样式主题是一个附加到当前幻灯片的样式，位于文件开头，由三个加号（+++）包围。如果你的幻灯片没有额外的样式，开头的和结尾的 +++ 是可选的。

示例

+++
background-color: black;
color: white;  

h1 {
    color: red;
}
+++
# I am red 

I am white and my background is black

自定义 CSS 属性

unveil 使用一些自定义 CSS 属性来帮助您设计幻灯片。

例如，您可以在幻灯片的样式主题中使用 --on-enter-animation CSS 属性添加过渡效果。

+++
--on-enter-animation: zoom-in
+++
# I will zoom in on enter

可用的自定义 CSS 属性

| 名称 | 允许的值 | 状态 |
| :--- | :--- | 实现 | |--on-enter-animation | fade-in, zoom-in

如果您想在 unveil 中看到更多自定义属性和过渡效果，请告诉我们！

Hljs

unveil 使用 hljs 生成漂亮的代码片段。Rust 代码可以通过 Rust playground 项目 进行播放。

命令

贡献

unveil 处于开发的早期阶段，任何帮助都受欢迎。如果您想参与，请阅读 贡献指南 并选择一个 问题！

获取帮助

需要帮助？您可以通过我们的 matrix 频道 或在 问题跟踪器 上提问来联系我们。