marp README

The project's README from github.com/marp-team/marp. As one markdown file: README.md.

Marp Marp

Marp: Markdown Presentation Ecosystem

Marp is the ecosystem to write your presentation with plain Markdown.

🌐 Website ▶︎ | 💬 Discussion forum ▶︎ | 😎 Awesome list ▶︎

Marp family

Our project is spread over many repos in order to focus on a limited scope per repository.

This repo (marp-team/marp) is an entrance to the Marp family, and places our website in /website.

Framework / Core

Name Description Release
Marpit The skinny framework for creating slide deck from Markdown. (marpit.marp.app) @marp-team/marpit
Marp Core The core of Marp converter with practical features and built-in themes. @marp-team/marp-core

Apps

Name Description Release
Marp CLI Marp Core / Marpit's CLI interface to convert into HTML, PDF, PPTX, and image(s). @marp-team/marp-cli

Integrations

Name Description Release
Marp for VS Code A VS Code extension to preview the slide deck written in Marp Markdown. VS Marketplace
See outdated/inactive projects...
Name Description Release
Marp Web The Web interface of Marp based on PWA and Preact framework. tech demo
Marp React Marp renderer component for React. @marp-team/marp-react
Marp Vue Marp renderer component for Vue. @marp-team/marp-vue

And there is a gravesite of classic Marp app in https://github.com/yhatt/marp. :ghost:

Ecosystem

Marp ecosystem has a lot of cool stuffs for making awesome presentation. Check out the awesome list of Marp. 😎

Contributing

Marp and sub-projects are following the contributing guideline of marp-team. Please read this before starting work in our projects.

Author

Managed by @marp-team.

Sponsors

We are supported by them! Thanks for our sponsors! :heart:

Organization sponsors

@markslides @moozaru-ch

Personal sponsors

Personal sponsors

Do you want to sponsor the member of Marp team? See GitHub Sponsors profile(s) from "♥︎ Sponsor" button at the top of repository.

License

MIT License

marp (marp-team/marp)

Searching Database…

12.6K ·GitHub
What is this?Marp is a Markdown-based presentation ecosystem; this repo is the entrance point that links together all the Marp family projects (Marpit, Marp Core, Marp CLI, Marp for VS Code, etc.) used to write slides in plain Markdown.
Is this a single tool, or a hub pointing to several separate projects?It's a hub: each piece of the ecosystem (the Marpit framework, Marp Core converter, Marp CLI, Marp for VS Code) lives in its own repository, and this repo mainly indexes them and hosts the marp.app website.
Which part of the ecosystem should I actually install to start making slides?For command-line conversion to HTML, PDF, PPTX or images, install Marp CLI; for writing and previewing slides in an editor, install the Marp for VS Code extension.
Are all the listed sub-projects still maintained?No — some, like Marp Web, Marp React, and Marp Vue, are flagged as outdated or inactive and are kept mostly for reference rather than active use.
What is Marpit?Marpit is the 'skinny framework for creating slide deck from Markdown' that powers the lower-level rendering used by other Marp tools.
What formats can Marp CLI export to?HTML, PDF, PPTX, and images, according to the CLI's entry in the family table.
Why is the project split into so many repositories?The team deliberately spreads Marp across multiple repos 'in order to focus on a limited scope per repository.'
Creator
marp-team
Size
5.1 MB
Stars
12.6K
Updated
CommitJul 29
Age
8y
Commits · 90 Days