marp - GitLite

KO | EN

gitlite — search

#javascript #react #llm #rust #deep-learning #linux #docker #nodejs #java #windows #cli #kubernetes #pytorch #mcp

marp

(★ 12,388)

The entrance repository of Markdown presentation ecosystem

File Explorer

Download Latest Version (.zip)

- - test.yml
- dependabot.yml
- - 202205-ecosystem-update.md
  - how-to-make-custom-transition.md
  - marp-for-vs-code-v1.md
  - marpit-v2-marp-core-v2-and-marp-cli-v1.md
  - re-creation-of-marp-website.md
  - the-story-of-marp-next.md
- - Button.tsx
  - CodeBlock.tsx
  - Footer.tsx
  - Header.tsx
  - Layout.tsx
  - Marp.tsx
  - ScrollToTop.tsx
  - Title.tsx
  - Typography.tsx
- - index.css
  - plugin-rem.js
- - manifest.yaml
- - 404.tsx
  - _app.tsx
  - _document.tsx
  - blog.tsx
  - index.tsx
- - apple-touch-icon-180x180.png
  - favicon.png
- - date.ts
  - title.ts
  - url.ts
- .env.development
- .env.production
- .eslintrc.js
- assets.d.ts
- babel.config.js
- global.d.ts
- next-env.d.ts
- next.config.js
- package.json
- postcss.config.js
- tailwind.config.js
- tsconfig.json
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
LICENSE
marp-dark.png
marp.png
netlify.toml
package.json
README.md
tsconfig.json
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/marp-team/marp

Downloads the entire project code from GitHub to your computer.

cd marp

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  <p>
    <img src="marp.png#gh-light-mode-only" alt="Marp" width="450" />
    <img src="marp-dark.png#gh-dark-mode-only" alt="Marp" width="450" />
  </p>
  <p>
    <strong>Marp</strong>: Markdown Presentation Ecosystem
  </p>
</div>

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

<div align="center">

### [🌐 Website ▶︎](https://marp.app)&emsp;|&emsp;[💬 Discussion forum ▶︎](https://github.com/marp-team/marp/discussions)&emsp;|&emsp;[😎 Awesome list ▶︎](https://github.com/marp-team/awesome-marp)

</div>

## Marp family

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

This repo (**[marp-team/marp][marp]**) is an entrance to the Marp family, and places [our website](https://marp.app/) in `/website`.

### Framework / Core

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

### Apps

|                     Name | Description                                                                                      | Release                                                |
| -----------------------: | :----------------------------------------------------------------------------------------------- | :----------------------------------------------------- |
| **[Marp CLI][marp-cli]** | [Marp Core][marp-core] / [Marpit]'s CLI interface to convert into HTML, PDF, PPTX, and image(s). | [![@marp-team/marp-cli][badge-marp-cli]][marp-cli-npm] |

### Integrations

|                                Name | Description                                                                       | Release                                                     |
| ----------------------------------: | :-------------------------------------------------------------------------------- | :---------------------------------------------------------- |
| **[Marp for VS Code][marp-vscode]** | A [VS Code][vscode] extension to preview the slide deck written in Marp Markdown. | [![VS Marketplace][badge-marp-vscode]][marp-vscode-release] |

<details>
<summary>See outdated/inactive projects...</summary><br />

|                     Name | Description                                                      | Release                                                      |
| -----------------------: | :--------------------------------------------------------------- | :----------------------------------------------------------- |
|     [Marp Web][marp-web] | The Web interface of Marp based on [PWA] and [Preact] framework. | [![tech demo][badge-marp-web]][marp-web-site]                |
| [Marp React][marp-react] | Marp renderer component for [React].                             | [![@marp-team/marp-react][badge-marp-react]][marp-react-npm] |
|     [Marp Vue][marp-vue] | Marp renderer component for [Vue].                               | [![@marp-team/marp-vue][badge-marp-vue]][marp-vue-npm]       |

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

[marp-web]: https://github.com/marp-team/marp-web
[marp-react]: https://github.com/marp-team/marp-react
[marp-vue]: https://github.com/marp-team/marp-vue
[pwa]: https://en.wikipedia.org/wiki/Progressive_Web_Apps
[preact]: https://preactjs.com/
[react]: https://reactjs.org/
[vue]: https://vuejs.org/
[marp-web-site]: https://web.marp.app/
[marp-react-npm]: https://www.npmjs.com/package/@marp-team/marp-react
[marp-vue-npm]: https://www.npmjs.com/package/@marp-team/marp-vue
[badge-marp-web]: https://img.shields.io/badge/%E2%80%8B-tech%20demo-%230288d1.svg?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAAUUlEQVQokWNgGD6AqePif3Sx9B2PMcQwNKFrTN/x+D9ejTBNyBphmnBqRNYE04isCatGdE1MHRf/o2vC0IhNE1PaXPwacWnCqxGfJoI2Dn4AAN0ZrMM1VUFvAAAAAElFTkSuQmCC
[badge-marp-react]: https://img.shields.io/npm/v/@marp-team/marp-react.svg?style=flat-square&logo=npm
[badge-marp-vue]: https://img.shields.io/npm/v/@marp-team/marp-vue.svg?style=flat-square&logo=npm

</details>

[yhatt/marp]: https://github.com/yhatt/marp
[marp]: https://github.com/marp-team/marp
[marpit]: https://github.com/marp-team/marpit
[marp-core]: https://github.com/marp-team/marp-core
[marp-core-themes]: https://github.com/marp-team/marp-core/tree/main/themes
[marp-cli]: https://github.com/marp-team/marp-cli
[marp-vscode]: https://github.com/marp-team/marp-vscode
[vscode]: https://code.visualstudio.com/
[marpit.marp.app]: https://marpit.marp.app/
[marpit-npm]: https://www.npmjs.com/package/@marp-team/marpit
[marp-core-npm]: https://www.npmjs.com/package/@marp-team/marp-core
[marp-cli-npm]: https://www.npmjs.com/package/@marp-team/marp-cli
[marp-vscode-release]: https://marketplace.visualstudio.com/items?itemName=marp-team.marp-vscode
[badge-marpit]: https://img.shields.io/npm/v/@marp-team/marpit.svg?style=flat-square&logo=npm
[badge-marp-core]: https://img.shields.io/npm/v/@marp-team/marp-core.svg?style=flat-square&logo=npm
[badge-marp-cli]: https://img.shields.io/npm/v/@marp-team/marp-cli.svg?style=flat-square&logo=npm
[badge-marp-vscode]: https://img.shields.io/github/v/release/marp-team/marp-vscode.svg?style=flat-square&label=Marketplace

## Ecosystem

Marp ecosystem has a lot of cool stuffs for making awesome presentation. Check out **[the awesome list of Marp](https://github.com/marp-team/awesome-marp)**. 😎

## Contributing

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

[contributing]: https://github.com/marp-team/.github/blob/master/CONTRIBUTING.md

## Author

Managed by [@marp-team](https://github.com/marp-team).

- <img src="https://github.com/yhatt.png" width="16" height="16"/> Yuki Hattori ([@yhatt](https://github.com/yhatt))

## Sponsors

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

### Organization sponsors

<p align="center">
  <a href="https://github.com/markslides"><img src="https://github.com/markslides.png" width="120" height="120" alt="@markslides" valign="middle" hspace="8" /></a>
  <a href="https://github.com/moozaru-ch"><img src="https://github.com/moozaru-ch.png" width="120" height="120" alt="@moozaru-ch" valign="middle" hspace="8" /></a>
</p>

### Personal sponsors

<p align="center">
  <img alt="Personal sponsors" src="https://yhatt.github.io/yhatt/sponsors.svg" />
</p>

> Do you want to sponsor [the member of Marp team](https://github.com/orgs/marp-team/people)? See [GitHub Sponsors](https://github.com/sponsors) profile(s) from "♥︎ Sponsor" button [at the top of repository](https://github.com/marp-team/marp).

## License

[MIT License](LICENSE)