项目作者: foliejs

项目描述 :
folie-ppt-show
高级语言: JavaScript
项目地址: git://github.com/foliejs/folie-ppt.git
创建时间: 2017-03-09T16:59:04Z
项目社区:https://github.com/foliejs/folie-ppt

开源协议:

下载


nodePPT - 让你爱上做分享!

This is a readme file in English

NPM
NPM

导出pdf不再支持,请使用chrome打印服务另存为pdf,url中添加print=1,然后使用chrome打印 ctrl+P

为什么选择nodePPT

这可能是迄今为止最好的网页版演示库

demo

1.4 新功能

支持单个slide事件:build/enter/leave/keypress,事件统一在[slide]中使用data-on-X来指定一个全局函数名

事件说明如下

  • build:当触发下一步操作的时候,会触发这个事件,具有stop方法
  • keypress:在当前页面按键触发,具有stop方法
  • enter/leave:进入/离开 此页面触发的事件,无stop方法

build/keypress会在当前slide完全渲染后触发,回调函数会接受一个event对象,如果想阻止默认事件(即翻页,或者对应的快捷键),可以使用event对象的stop()方法;slide退场后事件解绑

使用举例

示例1:进入页面如果触发翻页事件,就会当前执行做转场,做一些类似magicmove效果

  1. [slide data-on-build="globalCallbackName"]
  1. var count = 0;
  2. function globalCallbackName(e){
  3. count++;
  4. if(count<2){
  5. //做一些页面动效,或者转场
  6. e.stop();//阻止默认事件,就不会跳转
  7. }
  8. }

示例2:代理空格按键事件

  1. [slide data-on-keypress="globalCallbackName"]
  1. function globalCallbackName(e){
  2. if(e.keyCode==32){
  3. //play();//触发自定义的页面效果
  4. e.stop();//阻止默认事件,则不会触发nodeppt默认绑定的事件
  5. }
  6. }

文件定位

对于nodeppt内部的文件,定位需要用根目录的方式来写,例如项目路径是 slidedemo.md中的图片使用:

  1. ![测试文件路径](/img/demo.png)

对应的图片路径是 slide/img/demo.png

使用 nodeppt generate demo.md output -a 则生成后,图片路径是:output/img/demo.png

magic

magic是在一页幻灯片中播放多个子页面,页面之间进行动效切换,但是slide不翻页(类似keynote的magicmove),使用[magic]标签包裹,子页面之间使用====间隔

[magic]标签支持全部转场动效,效果比较好的有:

  • zoomin/zoomout
  • move
  • circle
  • earthquake
  • newspaper
  • cover-diamond
  • horizontal3d/horizontal
  • vertical3d
  • cover-circle
  1. [slide]
  2. [magic data-transition="earthquake"]
  3. ## 标题1
  4. -----
  5. <div class="columns3">
  6. <img src="/assets/searchbox-fe-framework-and-product/Snip20151209_11.png" height="450">
  7. <img src="/assets/searchbox-fe-framework-and-product/Snip20151209_10.png" height="450">
  8. <img src="/assets/searchbox-fe-framework-and-product/Snip20151209_12.png" height="450">
  9. </div>
  10. ====
  11. ## 标题2
  12. -----
  13. <div class="columns3">
  14. <img src="/assets/searchbox-fe-framework-and-product/Snip20151209_11.png" height="450">
  15. <img src="/assets/searchbox-fe-framework-and-product/Snip20151209_10.png" height="450">
  16. <img src="/assets/searchbox-fe-framework-and-product/Snip20151209_12.png" height="450">
  17. </div>
  18. ====
  19. ## 标题3
  20. -----
  21. <div class="columns3">
  22. <img src="/assets/searchbox-fe-framework-and-product/Snip20151209_11.png" height="450">
  23. <img src="/assets/searchbox-fe-framework-and-product/Snip20151209_10.png" height="450">
  24. <img src="/assets/searchbox-fe-framework-and-product/Snip20151209_12.png" height="450">
  25. </div>
  26. [/magic]

theme 自定义

感觉默认的模板不符合新意?可以支持自定义模板,查看theme.moon

自定义后的模板路径在markdown的设置里填写:

  1. title: 这是演讲的题目
  2. speaker: 演讲者名字
  3. url: 可以设置链接
  4. transition: 转场效果,例如:zoomin/cards/slide
  5. files: /css/theme.moon.css,尾部的文件
  6. theme: moon //皮肤
  7. highlightStyle: monokai_sublime //hljs的样式
  8. headFiles: //头部的文件
  9. usemathjax: //如果为yes,则引入mathjax,默认不建议开启,导出文件太多
  10. date: 20151220

另外有:colors-moon-blue-dark-green-light 共六套自带皮肤可供选择

  1. theme: moon

or url?theme=moon

安装

  1. npm install -g nodeppt

shell使用

启动

  1. # 获取帮助
  2. nodeppt start -h
  3. # 绑定端口
  4. nodeppt start -p <port>
  1. nodeppt start -p 8090 -d ppts/
  2. # 绑定host,默认绑定0.0.0.0
  3. nodeppt start -p 8080 -d ppts/ -H 127.0.0.1
  4. # 使用socket通信(按Q键显示/关闭二维码,手机扫描,即可控制)
  5. # socket须知:1、注意手机和pc要可以相互访问,2、防火墙,3、ip

启用socket控制

方法一:使用url参数
  1. http://127.0.0.1:8080/md/demo.md?controller=socket

在页面按键【Q】显示控制url的二维码和控制链接(需要隐身窗口打开),手机上可以使用左右touch滑动和摇一摇切换下一页

方法二:使用start命令行
  1. nodeppt start -c socket

在页面按键【Q】显示控制url的二维码和控制链接(需要隐身窗口打开),手机上可以使用左右touch滑动和摇一摇切换下一页

启用postMessage控制

默认使用postMessage多窗口控制,打开方法:

  1. http://127.0.0.1:8080/md/demo.md?_multiscreen=1

事件绑定

使用函数Slide.on,目前支持update函数,即转场后的回调。示例代码:

  1. Slide.on('update', function(i, itemIndex, cls) {
  2. //接受三个参数:
  3. //* 当前slide的index
  4. //* itemIndex当前slide进入的第几个build动画,从1开始
  5. //* 方向pageup/pagedown
  6. Puff.add('#FFC524' /*colors[i % 6]*/ , ctx, 20, 700, width / 2, height / 2, width / 1.8, 400);
  7. clearInterval(timer);
  8. //第十三个有动效
  9. if (i === 13 || i === 14) {
  10. timer = setInterval(function() {
  11. Puff.draw(1);
  12. }, 1E3 / FPS);
  13. }
  14. })

demo中第13张使用回调做了魔幻翻页效果

打印/导出ppt

这么高端大气上档次的ppt,怎么能不导出分享给大家呢??

使用url?print=1访问页面,然后选择chrome的系统打印即可

html版

  1. # 获取generate帮助
  2. nodeppt generate -h
  3. # 使用generate命令
  4. nodeppt generate filepath
  5. # 导出全部,包括nodeppt的js、img和css文件夹
  6. # 默认导出在publish文件夹
  7. nodeppt generate ./ppts/demo.md -a
  8. # 指定导出文件夹
  9. nodeppt generate ./ppts/demo.md output/path -a

导出目录下所有ppt,并且生成ppt list首页:

  1. nodeppt path output/path -a

markdown语法

nodeppt是支持marked语法的,但是为了制作出来更加完美的ppt,扩展了下面的语法

配置

基本配置如下:

  1. title: 这是演讲的题目
  2. speaker: 演讲者名字
  3. url: 可以设置链接
  4. transition: 转场效果,例如:zoomin/cards/slide
  5. files: 引入jscss的地址,如果有的话~自动放在页面底部

目录关系:可以在md同级目录下创建img、js、css等文件夹,然后在markdown里面引用,nodeppt默认会先查找md文件同级目录下面的静态资源,没有再找默认的assets文件夹下静态内容


支持的转场动画包括:

  • kontext
  • vkontext
  • circle
  • earthquake
  • cards
  • glue
  • stick
  • move
  • newspaper
  • slide
  • slide2
  • slide3
  • horizontal3d
  • horizontal
  • vertical3d
  • zoomin
  • zoomout
  • pulse

如果设置单页动画,请参考下面的单页动画设置部分~

分页

通过[slide]作为每页ppt的间隔,如果需要添加单页背景,使用下面的语法:

  1. [slide style="background-image:url('/img/bg1.png')"]
  2. # 这是个有背景的家伙
  3. ## 我是副标题

单页ppt上下布局

  1. [slide]
  2. ## 主页面样式
  3. ### ----是上下分界线
  4. ----
  5. nodeppt是基于nodejs写的支持 **Markdown!** 语法的网页PPT
  6. nodeppthttps://github.com/ksky521/nodePPT

代码格式化

语法跟Github Flavored Markdown 一样~

单条动画

使用方法:列表第一条加上 ` {:&.动画类型}``(注意空格)

  1. * 上下左右方向键翻页
  2. * 列表支持渐显动画 {:&.moveIn}
  3. * 支持多级列表
  4. * 这个动画是moveIn

目前支持的单条动画效果包括:

  • moveIn
  • fadeIn
  • bounceIn
  • rollIn
  • zoomIn

单页动画设置

在md文件,顶部 配置 可以设置全局转场动画,如果要设置单页的转场动画,可以通过下面的语法

  1. [slide data-transition="vertical3d"]
  2. ## 这是一个vertical3d的动画

插入html代码

如果需要完全diy自己的ppt内容,可以直接使用 html标签,支持markdown和html混编。例如:

  1. <div class="file-setting">
  2. <p>这是html</p>
  3. </div>
  4. <p id="css-demo">这是css样式</p>
  5. <p>具体看下项目中 ppts/demo.md 代码</p>
  6. <script>
  7. function testScriptTag(){
  8. }
  9. console.log(typeof testScriptTag);
  10. </script>
  11. <style>
  12. #css-demo{
  13. color: red;
  14. }
  15. </style>

转场回调

前端的ppt,难免会在页面中演示一些demo,除了上面的插入html语法外,还提供了enteroutcallback,分别用于:切入(切走)到当前ppt,执行的js函数名。例如:

  1. [slide data-on-leave="outcallback" data-on-enter="incallback"]
  2. ## 当进入此页,就执行incallback函数
  3. ## 当离开此页面,就执行outcallback函数

表格实例

  1. ### 市面上主要的css预处理器:less\sass\stylus
  2. ---
  3. |less| sass | stylus
  4. :-------|:------:|-------:|--------
  5. 环境 |js/nodejs | Ruby | nodejs
  6. 扩展名 | .less | .sass/.scss | .styl
  7. 特点 | 老牌,用户多,支持js解析 | 功能全,有成型框架,发展快 | 语法多样,小众
  8. 案例/框架 | [Bootstrap](http://getbootstrap.com/) | [compass](http://compass-style.org) [bourbon](http://bourbon.io) |

插入iframe

使用data-src作为iframe的url,这样只有切换到当前页才会加载url内容~

  1. <iframe data-src="http://www.baidu.com" src="about:blank;"></iframe>

示例

类似下面的语法:(更多用法查看ppts/demo.md文件)

  1. title: nodeppt markdown 演示
  2. speaker: Theo Wang
  3. url: https://github.com/ksky521/nodePPT
  4. transition: zoomin
  5. [slide]
  6. # 封面样式
  7. ## h1是作为封面用的,内部的都用h2
  8. [slide style="background-image:url('/img/bg1.png')"]
  9. # 背景图片 {:&.flexbox.vleft}
  10. ## 使用方法:[slide style="background-image:url('/img/bg1.png')"]
  11. [slide]
  12. ## 主页面样式
  13. ### ----是上下分界线
  14. ----
  15. nodeppt是基于nodejs写的支持 **Markdown!** 语法的网页PPT
  16. nodeppthttps://github.com/ksky521/nodePPT
  17. [slide]
  18. 什么?这些功能还不够用?
  19. 极客模式:查看源码的nodeppt.js,相信你会找到牛逼的手机互动(摇一摇换页)功能
  20. 查看项目目录ppts获取更多帮助信息

更多demo,查看 ppts 目录的demo

查看帮助

  1. nodeppt -h
  2. # 任何命令都可以输入-h查看帮助
  3. nodeppt start -h

demo演示 & 使用方法

Thanks