Skip to content

jasonhand/markdown_viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown 2 Slides

📊 Monitoring

Get free monitoring for this project with Datadog

A modern, web-based presentation generator that converts Markdown into beautiful slide presentations with live preview and multiple export options.

Features

  • Live Preview: Real-time markdown rendering with split-pane interface
  • Presentation Mode: Full-screen presentation with navigation controls
  • Multiple Themes: Default, Dark, Minimal, Elegant, and Corporate themes
  • Export Options: HTML, Standalone HTML, and PDF export capabilities
  • Editor Tools: Built-in formatting toolbar with markdown shortcuts
  • Local Storage: Auto-save functionality to preserve your work
  • Responsive Design: Works on desktop and mobile devices
  • Math Support: MathJax integration for mathematical expressions
  • Code Highlighting: Syntax highlighting via Prism.js
  • Speaker Notes: Support for speaker notes in presentations

Usage

  1. Getting Started: Open index.html in your web browser
  2. Writing: Use the left pane to write your markdown content
  3. Slide Breaks: Use --- to separate slides
  4. Preview: View your presentation in the right pane
  5. Present: Click the TV icon to enter full-screen presentation mode
  6. Export: Use the export button to save your presentation

Keyboard Shortcuts

  • Ctrl+S: Save current file
  • Ctrl+N: New file
  • Ctrl+B: Bold text
  • Ctrl+I: Italic text
  • F11: Enter presentation mode
  • ←/→: Navigate slides in presentation mode
  • ESC: Exit presentation mode

File Structure

├── index.html          # Main application file
├── manifest.json       # PWA manifest
├── js/
│   ├── app.js         # Main application logic
│   ├── editor.js      # Editor functionality
│   ├── preview.js     # Preview rendering
│   ├── presentation.js # Presentation mode
│   ├── storage.js     # Local storage management
│   ├── themes.js      # Theme switching
│   ├── fileManager.js # File management (WIP)
│   └── utils.js       # Utility functions
└── styles/
    ├── main.css       # Core styles
    ├── editor.css     # Editor styles
    ├── themes.css     # Theme definitions
    └── presentation.css # Presentation mode styles

Technologies Used

  • Marked.js: Markdown parsing
  • Prism.js: Syntax highlighting
  • MathJax: Mathematical expressions
  • Font Awesome: Icons
  • Google Fonts: Typography

Browser Support

Modern browsers with ES6+ support including:

  • Chrome 60+
  • Firefox 55+
  • Safari 11+
  • Edge 79+

Development

This is a client-side only application - no server required. Simply serve the files from any web server or open index.html directly in your browser.

License

See LICENSE file for details.

About

Markdown to HTML

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors