Neighborly Package Megalodon

    @marp-team/marpit
    TypeScript icon, indicating that this package has built-in type declarations

    2.2.0 • Public • Published

    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
    
    cd marpit
    
    yarn install
    yarn build

    Contributing

    Are you interested in contributing? Please see CONTRIBUTING.md and the common contributing guideline for Marp team.

    Sub-projects

    Author

    Managed by @marp-team.

    License

    This framework releases under the MIT License.

    Install

    npm i @marp-team/marpit

    DownloadsWeekly Downloads

    1,067

    Version

    2.2.0

    License

    MIT

    Unpacked Size

    154 kB

    Total Files

    57

    Last publish

    Collaborators

    • yhatt