项目结构
Slidev 对项目结构进行了一些约定,以尽量减少配置项,使功能扩展更加灵活直观。
基本结构如下所示:
your-slidev/
├── components/ # 自定义组件
├── layouts/ # 自定义布局
├── public/ # 静态资源
├── setup/ # 自定义 setup / hooks
├── styles/ # 自定义样式
├── index.html # 注入的 index.html
├── slides.md # 幻灯片主入口
└── vite.config.ts # 扩展 vite 配置
以上所有均为可选。
组件
约定:./components/*.{vue,js,ts,jsx,tsx,md}
此目录中的组件可以在幻灯片的 Markdown 中直接使用,其组件名与文件名相同。
示例:
your-slidev/
├── ...
└── components/
├── MyComponent.vue
└── HelloWorld.ts
<!-- slides.md -->
# My Slide
<MyComponent :count="4"/>
<!-- both namings work -->
<hello-world foo="bar">
Slot
</hello-world>
此特性得益于 unplugin-vue-components
。
Slidev 还提供了一些 内置组件 供你选择。
布局
约定:./layouts/*.{vue,js,ts,jsx,tsx}
your-slidev/
├── ...
└── layouts/
├── cover.vue
└── my-cool-theme.vue
你可以为布局文件使用任何文件名。然后只需在你的 YAML 头部使用文件名引用你的布局。
---
layout: my-cool-theme
---
如果你提供的布局与内置布局或主题布局重名的话,你的自定义布局将优先于内置/主题布局。优先级为 本地 > 主题 > 内置
。
在布局组件中,你可以使用 <slot/>
展示幻灯片内容。比如:
<!-- default.vue -->
<template>
<div class="slidev-layout default">
<slot />
</div>
</template>
静态资源
约定:./public/*
开发过程中,此目录中的资源文件将在 /
下提供,并会按原样复制到 dist 目录的根目录中。欲了解更多,请参阅 Vite 的 public
目录。
样式
约定:./style.css
| ./styles/index.{css,js,ts}
遵循上述约定的文件将被注入到 App 的根目录中。如果你需要引入多个 css 入口,你可以按如下方式创建结构并自行管理引入顺序。
your-slidev/
├── ...
└── styles/
├── index.ts
├── base.css
├── code.css
└── layouts.css
// styles/index.ts
import './base.css'
import './code.css'
import './layouts.css'
样式得益于 UnoCSS 和 PostCSS,你拥有开箱即用的 css 嵌套和 at-directives。示例:
.slidev-layout {
--uno: px-14 py-10 text-[1.1rem];
h1, h2, h3, h4, p, div {
--uno: select-none;
}
pre, code {
--uno: select-text;
}
a {
color: theme('colors.primary');
}
}
index.html
约定:index.html
index.html
提供了向主 index.html
中注入 meta 标签以及 scripts 标签的能力。
例如,对于以下自定义 index.html
来说:
<!-- ./index.html -->
<head>
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;600&family=Nunito+Sans:wght@200;400;600&display=swap" rel="stylesheet">
</head>
<body>
<script src="./your-scripts"></script>
</body>
最终部署的 index.html
效果如下:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="icon" type="image/png" href="https://cdn.jsdelivr.net/gh/slidevjs/slidev/assets/favicon.png">
<!-- injected head -->
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;600&family=Nunito+Sans:wght@200;400;600&display=swap" rel="stylesheet">
</head>
<body>
<div id="app"></div>
<script type="module" src="__ENTRY__"></script>
<!-- injected body -->
<script src="./your-scripts"></script>
</body>
</html>
全局图层
约定:global-top.vue
| global-bottom.vue
了解更多:全局图层