Skip to content

htlin222/lizard_marp

Repository files navigation

GitHub stars Last commit License

Marp Presentation Template

This repository contains my personal presentation templates using Marp (Markdown Presentation Ecosystem). Marp allows you to create beautiful presentations using simple Markdown syntax.

Prerequisites

Before you begin, ensure you have Node.js installed on your system.

Installation

  1. Clone this repository:
git clone htlin222/lizard_marp
cd lizard_marp
  1. Install the required dependencies:
npm install

Project Structure

.
├── README.md
├── package.json
├── contents/
│   ├── presentation1.md
│   ├── presentation2.md
│   └── ...
└── ...

All presentation files (.md) must be placed in the contents directory.

Usage

To start the development server:

npm run dev

This will launch a local server at http://localhost:8080 where you can view all your presentations.

Creating Presentations

  1. Create a new .md file in the contents directory
  2. Use Marp's markdown syntax to create your presentation
  3. View your presentation in real-time through the development server

Export Presentation

To html

npm run build -- contents/YOUR_FILE.md

To PDF

npm run build:pdf -- contents/YOUR_FILE.md

Example Presentation

see example

---
title: "example"
marp: true
author: Hsieh-Ting Lin
paginate: true
headingDivider: 3
theme: my-theme
footer: "[■](#table-of-contents)"
---

# example

#### 林協霆醫師,和信治癌中心醫院

**Hsieh-Ting Lin, <htlin222@kfsyscc.org>**

![h:50px](https://i.imgur.com/TLuxHNS.png)

# Preface

---

YOUR Content goes here

---

# Takeaway

---

## Table of Contents

[[TOC]]

About

Marp presentation template with custom CSS themes for markdown slide decks, supporting HTML/PDF export and a live development server.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors