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

Quick Start for Lupo.ai

Requirements

In this quick tutorial, we assume you already have your repository configured and ready to generate videos. If that's not the case, read the section Getting Started > Configuration.

1. Download the content of our hello world repository.

2. Copy it to your repo.

3. The hello-world repository contains the following files:

hello-world
├── .github
│   └── workflows
│       └── generate-course.yml
├── .vscode
│   ├── customsnippets.code-snippets
│   ├── extensions.json
│   └── settings.json
├── sample
│   └── sample.md
├── README.md
└── toc.yml

• .github/workflows/generate-course.yml: contains the GitHub action to generate the videos based on the content of this repository.
• .vscode/customsnippets.code-snippets: contains snippets or shortcuts to save you time when creating the same slides multiple times. More about snippets in Advanced > Snippets.
• .vscode/extensions.json: contains suggested extensions that will pop up if you don't have them installed when you open your project for the first time.
• .vscode/settings.json: contains suggested configurations for VSCode or its extensions. Here is where we add the themes. More about themes and customization in Styling.
• content/content.md: the content that will be generated is inside this file. The name and location of it could be anything because each markdown file's order, names, and location is specified inside the toc.yml.
• README.md: it's a regular GitHub readme file. It's optional.
• toc.yml: it's the most important file to generate your videos. Contains all the information and configuration required by lupo.

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

name: ProjectName
version: v1
speaker: Aria
email: help@lupo.ai
chapters:
  - name: Sample Chapter
    sections:
      - name: Sample Section
        href: sample/sample.md

As you can see, the toc.yml file contains all the configurations required to generate the video. The name of the Chapters and Sections are independent of the project folder names, and you can put your markdown files anywhere as long as you put the correct path in the toc file. More about the toc file in Project Structure > Table Of Contents.

5. The content of the sample.md file must follow a few rules:

• a header with marp: true
• three dashes separate each slide ---
• each slide has two elements: slide content in markdown and slide narration in html comments.

---
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" autoplay loop muted>

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

6. If you have followed the instructions until now, you are ready to generate your video. At this point, you have multiple options:

• navigate to your GitHub project actions, select generate-course > Run workflow > Run workflow
• if you have installed the GitHub actions extension, click on the GitHub actions icon. In the second panel called Workflows, click on the Generate Course play button (Trigger workflow).
• navigate to the lupo.ai website, go to my projects, search your project name, and click Generate Video.

All actions trigger the video generation process. Be a little patient if it appears slowly. It works with GitHub actions, so sometimes it requires a few seconds to allocate resources.

7. At the end of the generation process, you'll receive an email with the results. You can also check out the results online at your project page on lupo.ai.

If you have problems at any step, do not hesitate to write us for help, we will be more than happy to help you.