Kolibry

Directory Structure

Kolibry employs some directory structure conventions to minimize the configuration surface and to make the functionality extensions flexible and intuitive.

The basic structure is as follows:

your-kolibry/
  ├── components/       # custom components
  ├── layouts/          # custom layouts
  ├── public/           # static assets
  ├── setup/            # custom setup / hooks
  ├── 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

Conventions: ./components/*.{vue,js,ts,jsx,tsx,md}

Components inside this directory can be directly used in the slides Markdown with the same component name as the file name.

For example:

your-kolibry/
  ├── ...
  └── components/
      ├── MyComponent.vue
      └── HelloWorld.ts

<!-- slides.md -->

# My Slide

<MyComponent :count="4"/>

<!-- both namings work -->

<hello-world foo="bar">
  Slot
</hello-world>

This feature is powered by unplugin-vue-components, learn more there.

Kolibry also provides some built-in components for you to use.

Layouts

Conventions: ./layouts/*.{vue,js,ts,jsx,tsx}

your-kolibry/
  ├── ...
  └── layouts/
      ├── cover.vue
      └── my-cool-theme.vue

You can use any filename for your layout. You then reference your layout in you YAML header using the filename.

---
layout: my-cool-theme
---

If the layout you provide has the same name as a built-in layout or a theme layout, your custom layout will take precedence over the built-in/theme layout. The priority order is local > theme > built-in.

In the layout component, use <slot/> for the slide content. For example:

<!-- default.vue -->
<template>
  <div class="kolibry-layout default">
    <slot />
  </div>
</template>

Public

Conventions: ./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 Vite's public directory.

Style

Conventions: ./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 managing the import order yourself.

your-kolibry/
  ├── ...
  └── 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 out-of-box. For example:

.kolibry-layout {
  @apply px-14 py-10 text-[1.1rem];

  h1, h2, h3, h4, p, div {
    @apply select-none;
  }

  pre, code {
    @apply select-text;
  }

  a {
    color: theme('colors.primary');
  }
}

Learn more about the syntax.

index.html

Conventions: 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/kolibryjs/kolibry/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

Conventions: global-top.vue | global-bottom.vue

Learn more: Global Layers