Welcome!

• Getting Started
  • Configuration
  • Editor
  • Quick Start
• Project Structure
  • Template
  • Table of Contents (TOC)
  • Content
• Markdown
  • Introduction to Markdown
  • Basics
  • Lists
  • Links
  • Images
  • Code
  • Tables
  • Equations
  • Videos
  • Embedded
• Languages
  • Introduction to Languages
  • Narrators
  • Emotions
  • Translations
• Styling
  • Introduction to Styles
  • Custom Theme
• Advanced
  • Framed Narrations
  • Snippets
• Demos
  • Create Full Course

Template

In order to generate videos, lupo has two requirements:

1. A table of contents file.

2. A Markdown file for each video.

3. The content of the toc.yml (table of contents) file should looks like this:

name: [Project Name]
version: [Version]
email: [e-mail or e-mails, commas separated]
speaker: [Speaker]
chapters:
    - name: [Chapter Name]
        sections:
            - name: [Section Name]
                href: [Path/to/file.md]

As an example:

name: Hello world
version: v1
email: help@lupo.ai, dev@lupo.ai
speaker: Jenny
chapters:
  - name: Sample Chapter
    sections:
      - name: Sample Section
        href: samples/sample.md

And taking a look at the minimum:

name: [Project Name]
chapters:
  - name: [Chapter Name]
    sections:
      - name: [Section Name]
        href: [Path/to/file.md]

But considering the following:

• The default speaker will be set as Aria-US.
• If the email field is empty, the email will be automatically sent to the address associated with the GitHub user who activates it.

2. The content of of each .md file should looks like this:

---
marp: true
---

![bg]([url-image])

# [Title]

## [Subtitle]

[text]

<!-- 
[Narration]
-->

---

* [Item 1]
* [Item 2]
* [Item 3]

<!-- 
[Narration 2]
-->

Here's an example markdown document that follows these guidelines and uses some basic Marp features:

---
marp: true
---

![bg](https://mlgstorageaccount.blob.core.windows.net/media/samples/forest.jpg)

# Hello World with Lupo!

## lupo.ai

<!-- 
Welcome to our hello world with Lupo Template!
-->

---

We recommend using this template for any new project you are starting.

Below we explain what it includes.

<!-- 
We recommend using this template for any new project you are starting. Below we explain what it includes.
-->

---

* `toc.yml` [required]: configuration file.
* `themes/customtheme.css` [optional]: custom theme css.
* `.vscode/customsnippets.code-snippets`: [optional]: save time creating slides.
* `.vscode/extensions.json` [optional]: recommendations.
* `.vscode/settings.json` [optional]: marp theme settings.

<!-- 
The toc.yml contains the configuration of your project including features like speaker, speed, voice, and so on.

customtheme.css is a styles file where you can customize everything in your slides.

customsnippets.code-snippets is extremely useful for templates and saves you time when creating presentations. 

extensions.json contains recommended extensions for vs code. 

settings.json contains some marp configurations but it is mostly for the themes.
-->

---

<video src="https://mlgstorageaccount.blob.core.windows.net/media/samples/niagara_falls.mp4">

<!-- 
Thank you for your time! 
-->

And taking a look at the minimum:

---
marp: true
---

[text]

<!-- 
[Narration]
-->