Get Started

Introduction

Get up and running with Markdown Teleprompter in minutes.

Key Features

  • Markdown-first - Write scripts in plain markdown with full formatting support
  • Real-time sync - Control from one window, display on another
  • Chapter navigation - Split scripts with --- separators
  • MDC Components - Add alerts, speaker labels, speed controls, and pauses
  • Customizable styling - Colors, fonts, margins, and more
  • Keyboard shortcuts - Full keyboard control in both windows
  • No backend required - Everything runs in your browser

Installation

Clone the repository and install dependencies:

git clone https://github.com/psoaresbj/md-web-prompter.git
cd md-web-prompter
npm install

Start the development server:

npm run dev

Open http://localhost:3000 in your browser.

Quick Start

Get up and running in 60 seconds:

1. Write your script

Go to Scripts and create or edit a script using markdown.

2. Configure display

Open Controller to adjust speed, colors, and font size.

3. Start presenting

Click Open Display and press Space to begin.

Typical Workflow

  1. Write your script in the Scripts page using markdown
  2. Use --- to create chapter breaks for easy navigation
  3. Add ::speaker, ::alert, or ::pause components as needed
  4. Open the Controller and click "Open Display"
  5. Drag the display window to your external monitor or teleprompter hardware
  6. Press Space to start scrolling
  7. Use arrow keys to navigate or adjust speed on the fly

Next Steps