Giter VIP home page Giter VIP logo

pi2pie / marpit-with-revealjs-sample Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 179 KB

This sample modified by pi2pie. This is a side project for experiencing how to let them work together and also how to make slides more efficiently.

Home Page: https://mapit-with-revealjs-sample-modified-by-pi2pie.netlify.app

License: MIT License

JavaScript 7.24% CSS 30.54% HTML 0.69% SCSS 61.52%
examples markdown marpit reveal-js revealjs slides

marpit-with-revealjs-sample's Introduction

marpit-with-revealjs-sample

Currently, Marpit has not fully supported Reveal.js.
However, some functions are able to be implemented by writing Html in the Markdown file.
Indeed, this way sounds weird, but it works.

⚠︎ > [bg] does not work properly with MarpIt + Reveal.js

⚡︎ > transition in slides should be used Marpit directives, instead of data-transition in Reveal.js

Disclaimer

And this sample modified by pi2pie. This is a side project for experiencing how to let them work together and also how to make slides more efficiently.


Usage

First, clone this repo or use this template

git clone https://github.com/pi2pie/marpit-with-revealjs-sample.git

And remove the .git, and create your own.

$ cd marpit-with-revealjs-sample
$ rm -rf .git
$ git init
$ git add .
$ git commit -m 'init' -a

And then install packages.

$ yarn install

or

$ npm install

And the slides contents could be changed.
Get into src/slides.md
Modify this file, write the contents what you like.

Preview the slides.

$ npm run start

Build the slides in dist/*

$ npm run build

[!WARNING] > In slides.md, if you change styles instead of contents, run npm run build first. For this, the result would be the correct styles you set in your slides.md.

styles: your css class name or inline style.

Combined

$ npm run pack

This command would run build and start.


Structure

./src
├── app.js
├── assets
│   └── DocIconP.svg
├── contents
│   └── slides.md
├── css
│   ├── fonts.css
│   ├── light.css
│   ├── styles.css
│   └── utils-css /
├── index.html
└── plugins
    ├── auto-animate.js
    └── transition.js

This is the files structure.
assets/ directory is for media files, put your images or videos here.

// src/app.js
<!-- promo banner -->

<div class="promo-banner">
<a class="promo-link" href="/" rel="noopener noreferrer">
<img src="./assets/DocIconP.svg" alt=""></a>
</div>

And also, in app.js, the promo-banneruse ./assets/DocIconP.svg as Logo.
This one could be changed, it is just like a placeholder.

css: There is the utility-first css for the design concept here.

marpit-with-revealjs-sample's People

Contributors

dependabot[bot] avatar dev-pi2pie avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.