Skip to content
🎬 The Markdown Presentation Framework.
JavaScript CSS HTML
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
packages
website
.editorconfig
.gitignore
.travis.yml
LICENSE
README.md
lerna.json
package.json

README.md

Welcome to MDPPT 👋

0.0.0 Documentation License: MIT

(Still under development! not release yet!)

A framework for easily creating beautiful presentations using Markdown.

Homepage

Install

npm i @mdppt/cli -g

Usage

 mdppt new

 mdppt serve <filename>

 mdppt build <filename>

Multi Pages

 mdppt serve .

 mdppt build .

Custom configuration

Root of project create a mdppt.config.js file.

module.exports = {
  baseUrl: '/',
  outputDir: 'dist',
  // For multi pages
  pages: {
    // Whether to open multi-page configuration
    enable: false,
    // ignore folders
    ignore: ['**/node_modules/**'],
    // specify a the markdown file name as index page [required]
    entry: 'mdppt'
  },

  // webpack configuration
  devServer: {
    port: 8080,
    open: false
  }
}

Run in local

git clone https://github.com/ftbjs/mdppt.git

cd mdppt

npm i lerna -g

npm install

# install packages/ dependencies
npm run start

cd packages/mdppt

npm link

# execute all above steps
# you can run below command in global

mdppt serve <filename>
# or
mdppt build <filename>

Note: the file should be allow markdown file.e.g. DEMO

Author

👤 BiYuqi

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

Give a star

📝 License

Copyright © 2019 BiYuqi.

This project is MIT licensed.

You can’t perform that action at this time.