The skinny framework for creating slide deck from Markdown
Branch: master
Clone or download
Latest commit 11523de Feb 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Use the latest carbon and boron LTS release in CI environment Feb 13, 2019
.github Update CONTRIBUTING: Change to refer the common release section for team Nov 13, 2018
docs Fix broken emoji on document Feb 13, 2019
docsify Simplize watch logic for docsify style through nodemon Nov 13, 2018
src Use re-exported markdown-it Token class via state Feb 12, 2019
test Inject StateCore#marpit instead of StateCore#disableMarpit Jan 30, 2019
.eslintignore Initial commit (Move from personal repository) Mar 17, 2018
.eslintrc.yml Remove eslint-plugin-prettier and use format script to check Prettier Nov 5, 2018
.gitignore Porting docsify style from marp-team/marp Nov 13, 2018
.jsdoc.json Publish JSDoc about Marpit API powered by netlify Mar 24, 2018
.node-version Upgrade Node to v10.15.1 Jan 30, 2019
.prettierignore Porting docsify style from marp-team/marp Nov 13, 2018
.prettierrc.yml Apply Prettier to YAML setting files by adding .yml extensions Nov 5, 2018
.stylelintrc.yml Add stylelint to run linter for docsify style Nov 13, 2018
CHANGELOG.md 0.7.2 Feb 13, 2019
LICENSE Update license author to Marp team Oct 8, 2018
README.md Update README.md and introduction on docs Jan 21, 2019
api.md Change script name for building JSDoc from docs to jsdoc Aug 31, 2018
babel.config.js Require node >= 6.14.2 (Boron Maintenance LTS) Sep 2, 2018
index.d.ts Fix type definition: MarpitDirectiveDefinitions allows object and array Feb 4, 2019
jest.config.js Use setupFilesAfterEnv option in latest Jest config Jan 30, 2019
jest.setup.js Swap test framework from mocha to Jest Aug 3, 2018
package.json 0.7.2 Feb 13, 2019
version.js Update version script to work with Mac (#31) May 29, 2018
yarn.lock Upgrade dependent packages to latest Feb 13, 2019

README.md

Marpit

Marpit: Markdown slide deck framework

CircleCI Codecov npm LICENSE


Marpit /mɑːrpɪt/ is the skinny framework for creating slide deck from Markdown. It can transform Markdown and CSS theme(s) to slide deck composed of static HTML and CSS and create a web page convertible into slide PDF by printing.

Marpit is designed to output minimum assets for the slide deck. You can use the bare assets as a logicless slide deck, but mainly we expect to integrate output with other tools and applications.

In fact, this framework is created for using as the base of a core converter in the next version of Marp.

Features

📝 Marpit Markdown

We have extended several features into markdown-it parser to support writing awesome slides, such as Directives and Slide backgrounds. Additional syntaxes place importance on a compatibility with general Markdown documents.

🎨 Theme CSS by clean markup

Marpit has the CSS theming system that can design slides everything. Unlike other slide frameworks, there are not any predefined classes and mixins. You have only to focus styling HTML elements by pure CSS. Marpit would take care of the selected theme's necessary conversion.

📐 Inline SVG slide (Experimental)

Optionally <svg> element can use as the container of each slide page. It can be realized the pixel-perfect scaling of the slide only by CSS, so handling slides in integrated apps become simplified. The isolated layer made by <foreignObject> can provide advanced backgrounds for the slide with keeping the original Markdown DOM structure.

ℹ️ We not provide any themes because Marpit is just a framework. You can use @marp-team/marp-core if you want. It has the official themes, and practical features extended from Marpit.

Getting started

See the documentation of Marpit to get started.

Development

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

yarn install
yarn build

Contributing

Are you interested in contributing? Please see CONTRIBUTING.md.

Sub-projects

Author

Managed by @marp-team.

License

This framework releases under the MIT License.