Welcome to MDPPT 👋

(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

• Website: https://loadingmore.com
• Github: @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.