Git Product home page Git Product logo

mdppt's Introduction

Welcome to MDPPT 👋

0.0.0 Documentation License: MIT

(Still under development! not release yet!)

A framework for easily creating beautiful presentations using Markdown.

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.

mdppt's People

Contributors

biyuqi avatar

mdppt's Issues

Features

Link

https://colorhunt.co/

https://uigradients.com/

https://www.zhihu.com/question/41945099

https://webkul.github.io/coolhue/

Feature task

  • 支持命令行创建markdown样板文件 (mdppt new <filename>)
  • 重新设计api (支持用户自定义webpack配置)
  • 抽离公用函数包 mdppt-utils
  • 支持预览所有slide
  • 支持运行多页面 (支持多文件serve, 并且支持按原目录打包成页面)
  • catch error
  • Link 支持图标 并转化成图标
  • 支持flex布局 (需要编写markdown-it插件)
  • 支持提示性语句
  • 颜色配置管理(渐变,纯色) 注意class命名需要合理
  • 字体大小是否合理 refactor
  • 使用文档输出

Features list

  • 支持自定义favicon文件
    在执行命令行目录创建/public/目录,并创建favicon.ico 文件,mdppt有检测机制会去优先读取用户自定义文件.
  • 支持mdppt.config.js 文件个性化配置

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.