https://github.com/ftbjs/mdppt
:clapper: The Markdown Presentation Framework.
https://github.com/ftbjs/mdppt
keynotes mardown-to-ppt markdown-converter markdown-presentation markdown-to-slide presentation presentation-slides slides slideshow webpack
Last synced: 18 days ago
JSON representation
:clapper: The Markdown Presentation Framework.
- Host: GitHub
- URL: https://github.com/ftbjs/mdppt
- Owner: ftbjs
- License: mit
- Created: 2019-05-28T10:23:12.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-11-03T02:47:29.000Z (over 5 years ago)
- Last Synced: 2025-01-23T19:38:48.407Z (over 1 year ago)
- Topics: keynotes, mardown-to-ppt, markdown-converter, markdown-presentation, markdown-to-slide, presentation, presentation-slides, slides, slideshow, webpack
- Language: JavaScript
- Homepage: https://ftbjs.github.io/mdppt/
- Size: 510 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to MDPPT 👋
 []( ) [](https://github.com/ftbjs/mdppt/blob/master/LICENSE)
**(Still under development! not release yet!)**
> A framework for easily creating beautiful presentations using Markdown.
## [Homepage](https://github.com/ftbjs/mdppt)
## Install
```sh
npm i @mdppt/cli -g
```
## Usage
```js
mdppt new
mdppt serve
mdppt build
```
## Multi Pages
```js
mdppt serve .
mdppt build .
```
## Custom configuration
Root of project create a `mdppt.config.js` file.
```js
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
```sh
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
# or
mdppt build
```
Note: the file should be allow markdown file.[e.g. DEMO](https://raw.githubusercontent.com/ftbjs/mdppt/master/mdppt.md)
## Author
👤 **BiYuqi**
* Website: https://loadingmore.com
* Github: [@BiYuqi](https://github.com/BiYuqi)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/ftbjs/mdppt/issues).
## Show your support
Give a ⭐️ if this project helped you!
[Give a star](https://github.com/ftbjs/mdppt/stargazers)
## 📝 License
Copyright © 2019 [BiYuqi](https://github.com/BiYuqi).
This project is [MIT](https://github.com/ftbjs/mdppt/blob/master/LICENSE) licensed.