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.7K ·GitHub
Что это такое?Marp — экосистема для создания презентаций на основе Markdown. Этот репозиторий — точка входа, которая связывает все проекты семейства Marp (Marpit, Marp Core, Marp CLI, Marp for VS Code и другие), с помощью которых слайды пишутся на обычном Markdown.
Это один инструмент или хаб, который ссылается на несколько отдельных проектов?Это хаб: каждая часть экосистемы (фреймворк Marpit, конвертер Marp Core, Marp CLI, Marp for VS Code) находится в своём репозитории, а этот репозиторий в основном служит каталогом для них и размещает сайт marp.app.
Какую часть экосистемы мне нужно установить, чтобы начать делать слайды?Для конвертации в HTML, PDF, PPTX или изображения из командной строки установите Marp CLI. Для написания и просмотра слайдов в редакторе установите расширение Marp for VS Code.
Все ли перечисленные подпроекты до сих пор поддерживаются?Нет. Некоторые из них, например Marp Web, Marp React и Marp Vue, помечены как устаревшие или неактивные и сохраняются в основном для справки, а не для активного использования.
Что такое Marpit?Marpit — это «лёгкий фреймворк для создания слайдов из Markdown», который лежит в основе низкоуровневой отрисовки, используемой другими инструментами Marp.
В какие форматы может экспортировать Marp CLI?В HTML, PDF, PPTX и изображения — согласно записи о CLI в таблице семейства проектов.
Почему проект разделён на так много репозиториев?Команда намеренно распределяет Marp по нескольким репозиториям, «чтобы сосредоточиться на ограниченной области в каждом репозитории».
Creator
marp-team
Size
5.1 MB
Stars
12.7K
Updated
CommitJul 29
Age
8y
Commits · 90 Days