An open API service indexing awesome lists of open source software.

https://github.com/rohancyberops/slidev


https://github.com/rohancyberops/slidev

Last synced: 6 months ago
JSON representation

Awesome Lists containing this project

README

          

# Slidev by Rohan

**Slidev** is a modern presentation tool that enables developers to create slides using Markdown, Vue components, and the Vite ecosystem. This repository showcases a customized Slidev deck developed by Rohan, emphasizing developer-centric presentations.

## 📌 Project Overview

This project leverages the capabilities of Slidev to produce interactive and visually appealing presentations. Key features include:

- **Markdown-Based Slides**: Craft presentations using simple Markdown syntax.
- **Vue Integration**: Enhance slides with dynamic Vue components.
- **Vite-Powered**: Benefit from fast hot module replacement and optimized builds.
- **Custom Themes**: Apply and modify themes to match presentation aesthetics.
- **Presenter Mode**: Utilize dual-screen setups for speaker notes and audience views.
- **Export Options**: Convert presentations to PDF, PNG, or PPTX formats.

## 🚀 Getting Started

### Prerequisites

- **Node.js**: Ensure you have Node.js version 18 or higher installed.

### Installation

1. **Clone the Repository**:

```bash
git clone https://github.com/RohanCyberOps/Slidev.git
cd Slidev
```

2. **Install Dependencies**:

```bash
npm install
```

3. **Start the Development Server**:

```bash
npm run dev
```

Access the presentation at `http://localhost:3030`.

## 🛠️ Project Structure

- `slides.md`: Contains the main content of the presentation in Markdown format.
- `components/`: Directory for custom Vue components used within slides.
- `package.json`: Lists project dependencies and scripts.
- `.bolt/`: Configuration files for project tooling (if applicable).

## 📦 Scripts

- `npm run dev`: Launches the development server with hot reloading.
- `npm run build`: Compiles the presentation for production deployment.
- `npm run export`: Exports the presentation to static files (e.g., PDF).

## 📄 License

This project is licensed under the [MIT License](LICENSE.md).

---