0.4.1 • Published 4 months ago

present-markdown-now v0.4.1

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

PresentMarkdownNow

Effortlessly stream and present your Markdown slides live in-browser with PresentMarkdownNow. Ideal for educators, presenters, and anyone needing to create dynamic, real-time presentations. Simply write in Markdown, and let PresentMarkdownNow handle the live presentations!

Features

  • Live Streaming: Instantly stream your Markdown slides live in your browser.
  • Typewriter Effect: New changes appear with a captivating typewriter effect.
  • Marp CLI Compatibility: Create slides with simple Markdown or Marp CLI format.
  • Easy Access: View the latest slide at http://localhost:9500.
  • Full Presentation Download: Download your entire presentation anytime.

Demo

PresentMarkdownNow Demo

Installation

Install PresentMarkdownNow using npm:

npm install present-markdown-now

Or run it directly with npx:

npx https://github.com/muthuishere/present-markdown-now.git
npx present-markdown-now

Usage

Navigate to a folder containing your markdown file and run:

present-markdown-now

If the folder contains one markdown file, it will automatically be served. To specify a file:

present-markdown-now path/to/your/file.md

Example

Create a Markdown file (e.g., presentation.md) and run:

present-markdown-now presentation.md

Open your browser and go to http://localhost:9500 to see your live presentation.

Credits and Acknowledgements

Special thanks to the following projects for their invaluable contributions to PresentMarkdownNow:

  • Marp CLI: For enabling seamless markdown to presentation conversions.
  • Typewriter Effect: For adding dynamic typewriter effects to live presentations.

Third-Party Licenses

For information on third-party licenses used in PresentMarkdownNow, please refer to the Third Party Licenses page.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

License

MIT