| 1 | <div align="center"> |
| 2 | <p> |
| 3 | <img src="marp.png#gh-light-mode-only" alt="Marp" width="450" /> |
| 4 | <img src="marp-dark.png#gh-dark-mode-only" alt="Marp" width="450" /> |
| 5 | </p> |
| 6 | <p> |
| 7 | <strong>Marp</strong>: Markdown Presentation Ecosystem |
| 8 | </p> |
| 9 | </div> |
| 10 | |
| 11 | **Marp** is the ecosystem to write your presentation with plain Markdown. |
| 12 | |
| 13 | <div align="center"> |
| 14 | |
| 15 | ### [🌐 Website ▶︎](https://marp.app) | [💬 Discussion forum ▶︎](https://github.com/marp-team/marp/discussions) | [😎 Awesome list ▶︎](https://github.com/marp-team/awesome-marp) |
| 16 | |
| 17 | </div> |
| 18 | |
| 19 | ## Marp family |
| 20 | |
| 21 | Our project is spread over many repos in order to focus on a limited scope per repository. |
| 22 | |
| 23 | This repo (**[marp-team/marp][marp]**) is an entrance to the Marp family, and places [our website](https://marp.app/) in `/website`. |
| 24 | |
| 25 | ### Framework / Core |
| 26 | |
| 27 | | Name | Description | Release | |
| 28 | | -------------------------: | :------------------------------------------------------------------------------------------ | :-------------------------------------------------------- | |
| 29 | | **[Marpit]** | The skinny framework for creating slide deck from Markdown. ([marpit.marp.app]) | [![@marp-team/marpit][badge-marpit]][marpit-npm] | |
| 30 | | **[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] | |
| 31 | |
| 32 | ### Apps |
| 33 | |
| 34 | | Name | Description | Release | |
| 35 | | -----------------------: | :----------------------------------------------------------------------------------------------- | :----------------------------------------------------- | |
| 36 | | **[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] | |
| 37 | |
| 38 | ### Integrations |
| 39 | |
| 40 | | Name | Description | Release | |
| 41 | | ----------------------------------: | :-------------------------------------------------------------------------------- | :---------------------------------------------------------- | |
| 42 | | **[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] | |
| 43 | |
| 44 | <details> |
| 45 | <summary>See outdated/inactive projects...</summary><br /> |
| 46 | |
| 47 | | Name | Description | Release | |
| 48 | | -----------------------: | :--------------------------------------------------------------- | :----------------------------------------------------------- | |
| 49 | | [Marp Web][marp-web] | The Web interface of Marp based on [PWA] and [Preact] framework. | [![tech demo][badge-marp-web]][marp-web-site] | |
| 50 | | [Marp React][marp-react] | Marp renderer component for [React]. | [![@marp-team/marp-react][badge-marp-react]][marp-react-npm] | |
| 51 | | [Marp Vue][marp-vue] | Marp renderer component for [Vue]. | [![@marp-team/marp-vue][badge-marp-vue]][marp-vue-npm] | |
| 52 | |
| 53 | And there is a gravesite of classic Marp app in https://github.com/yhatt/marp. :ghost: |
| 54 | |
| 55 | [marp-web]: https://github.com/marp-team/marp-web |
| 56 | [marp-react]: https://github.com/marp-team/marp-react |
| 57 | [marp-vue]: https://github.com/marp-team/marp-vue |
| 58 | [pwa]: https://en.wikipedia.org/wiki/Progressive_Web_Apps |
| 59 | [preact]: https://preactjs.com/ |
| 60 | [react]: https://reactjs.org/ |
| 61 | [vue]: https://vuejs.org/ |
| 62 | [marp-web-site]: https://web.marp.app/ |
| 63 | [marp-react-npm]: https://www.npmjs.com/package/@marp-team/marp-react |
| 64 | [marp-vue-npm]: https://www.npmjs.com/package/@marp-team/marp-vue |
| 65 | [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 |
| 66 | [badge-marp-react]: https://img.shields.io/npm/v/@marp-team/marp-react.svg?style=flat-square&logo=npm |
| 67 | [badge-marp-vue]: https://img.shields.io/npm/v/@marp-team/marp-vue.svg?style=flat-square&logo=npm |
| 68 | |
| 69 | </details> |
| 70 | |
| 71 | [yhatt/marp]: https://github.com/yhatt/marp |
| 72 | [marp]: https://github.com/marp-team/marp |
| 73 | [marpit]: https://github.com/marp-team/marpit |
| 74 | [marp-core]: https://github.com/marp-team/marp-core |
| 75 | [marp-core-themes]: https://github.com/marp-team/marp-core/tree/main/themes |
| 76 | [marp-cli]: https://github.com/marp-team/marp-cli |
| 77 | [marp-vscode]: https://github.com/marp-team/marp-vscode |
| 78 | [vscode]: https://code.visualstudio.com/ |
| 79 | [marpit.marp.app]: https://marpit.marp.app/ |
| 80 | [marpit-npm]: https://www.npmjs.com/package/@marp-team/marpit |
| 81 | [marp-core-npm]: https://www.npmjs.com/package/@marp-team/marp-core |
| 82 | [marp-cli-npm]: https://www.npmjs.com/package/@marp-team/marp-cli |
| 83 | [marp-vscode-release]: https://marketplace.visualstudio.com/items?itemName=marp-team.marp-vscode |
| 84 | [badge-marpit]: https://img.shields.io/npm/v/@marp-team/marpit.svg?style=flat-square&logo=npm |
| 85 | [badge-marp-core]: https://img.shields.io/npm/v/@marp-team/marp-core.svg?style=flat-square&logo=npm |
| 86 | [badge-marp-cli]: https://img.shields.io/npm/v/@marp-team/marp-cli.svg?style=flat-square&logo=npm |
| 87 | [badge-marp-vscode]: https://img.shields.io/github/v/release/marp-team/marp-vscode.svg?style=flat-square&label=Marketplace |
| 88 | |
| 89 | ## Ecosystem |
| 90 | |
| 91 | 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)**. 😎 |
| 92 | |
| 93 | ## Contributing |
| 94 | |
| 95 | Marp and sub-projects are following the [contributing guideline of marp-team][contributing]. Please read this before starting work in our projects. |
| 96 | |
| 97 | [contributing]: https://github.com/marp-team/.github/blob/master/CONTRIBUTING.md |
| 98 | |
| 99 | ## Author |
| 100 | |
| 101 | Managed by [@marp-team](https://github.com/marp-team). |
| 102 | |
| 103 | - <img src="https://github.com/yhatt.png" width="16" height="16"/> Yuki Hattori ([@yhatt](https://github.com/yhatt)) |
| 104 | |
| 105 | ## Sponsors |
| 106 | |
| 107 | We are supported by them! Thanks for our sponsors! :heart: |
| 108 | |
| 109 | <!-- [NOTE] Sort sponsors by name when modify. --> |
| 110 | |
| 111 | ### Organization sponsors |
| 112 | |
| 113 | <!-- Logo and links for top-tier sponsors (The image should be up to 400px on a side) --> |
| 114 | |
| 115 | <p align="center"> |
| 116 | <a href="https://github.com/markslides"><img src="https://github.com/markslides.png" width="120" height="120" alt="@markslides" valign="middle" hspace="8" /></a> |
| 117 | <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> |
| 118 | </p> |
| 119 | |
| 120 | <!-- [TODO] For mid-tier sponsors: As the same format as personal sponsors, add small icons and links to GitHub organization. --> |
| 121 | <!-- |
| 122 | <p> |
| 123 | <a href="https://github.com/xxxxxx"><img src="https://github.com/xxxxxx.png" width="32" height="32" alt="xxxxxx" /></a> |
| 124 | </p> |
| 125 | --> |
| 126 | |
| 127 | ### Personal sponsors |
| 128 | |
| 129 | <!-- [TODO] Currently shows maintainer's sponsors. We should show sponsors for all Marp team members in future. --> |
| 130 | |
| 131 | <p align="center"> |
| 132 | <img alt="Personal sponsors" src="https://yhatt.github.io/yhatt/sponsors.svg" /> |
| 133 | </p> |
| 134 | |
| 135 | > 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). |
| 136 | |
| 137 | ## License |
| 138 | |
| 139 | [MIT License](LICENSE) |
| 140 |