Directory Structure â
Slidev employs some directory structure conventions to minimize the configuration surface and to make the functionality extensions flexible and intuitive.
The conventional directory structure is:
your-slidev/
âââ components/ # custom components
âââ layouts/ # custom layouts
âââ public/ # static assets
âââ setup/ # custom setup / hooks
âââ snippets/ # code snippets
âââ styles/ # custom style
âââ index.html # injections to index.html
âââ slides.md # the main slides entry
âââ vite.config.ts # extending vite config
All of them are optional.
Components â
Pattern: ./components/*.{vue,js,ts,jsx,tsx,md}
Layouts â
Pattern: ./layouts/*.{vue,js,ts,jsx,tsx}
Public â
Pattern: ./public/*
Assets in this directory will be served at root path /
during dev, and copied to the root of the dist directory as-is. Read more about Assets Handling.
Style â
Pattern: ./style.css
| ./styles/index.{css,js,ts}
Files following this convention will be injected to the App root. If you need to import multiple CSS entries, you can create the following structure and manage the import order yourself.
your-slidev/
âââ ...
âââ styles/
âââ index.ts
âââ base.css
âââ code.css
âââ layouts.css
// styles/index.ts
import './base.css'
import './code.css'
import './layouts.css'
Styles will be processed by UnoCSS and PostCSS, so you can use CSS nesting and at-directives and Nested CSS out-of-box. For example:
.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');
}
}
Learn more about the syntax here.
index.html
â
Pattern: index.html
The index.html
provides the ability to inject meta tags and/or scripts to the main index.html
For example, for the following custom 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>
The final hosted index.html
will be:
<!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 Layers â
Pattern: global-top.vue
| global-bottom.vue
| custom-nav-controls.vue
| slide-top.vue
| slide-bottom.vue