nodePPT 简介及快速上手

nodePPT 版本升到 2.0,进行了比较大的重构。这个教程的内容针对新版的 nodePPT 已经不再准确。如果后面有机会,我会写一篇新的文章介绍 2.0 版本。

Markdown 是什么

在讨论 nodePPT 是什么之前,我想先说一下,Markdown是什么。如果你已经了解,可以快速翻过去。

Markdown 是一种轻量级的「标记语言」。

That’s all,不展开。

如果想进一步了解

简而言之,Markdown提供了一种 简便且易于理解的,内容与样式(或者叫格式)分离的编辑方式

当你编辑内容时,只专注于内容。
外观通过样式定义实现。(不用担心,有大量现成的定义得非常漂亮的样式表)
而一旦需要改动样式,不过修改一下样式,或者换个样式表,无论文档有多长,都不需要逐一修改。

那 nodePPT 又是什么

用作者自己的话

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

它是一个基于 node.js,html,css 等技术,用Markdown编写,在浏览器上实现类似 Power Point / KeyNote 效果的一个工具。

更多的信息,请参考项目主页 Github:nodePPT

又或者直接动手操作,在接下来的实际操作中,一边操作一边体会。

How-to

安装 node.js

因为很多工具依赖 node.js ,我把它的安装配置单独抽出来作为一篇,请参考 《nodejs 安装与配置》

安装 nodePPT

看到这里的时候,请确认你已经安装 node.js 并且配置好环境变量。然后接下来安装 nodePPT。 cmd 下,执行以下命令

1
npm install -g nodeppt

正常情况下,稍等一段时间,npm 会自动下载并且安装好。

安装完成,输入 nodeppt -v 并回车,正常应该返回版本号。如果不对,请根据错误信息,检查是 node.js 还是 nodePPT 没有正常安装。

编写演示文档

折腾半天,终于安装完,接下来开始编写演示文档。

首先找一个文件夹,用来存放演示文档的源文件,在这个文件夹空白处 shift + 右键 > 在此处打开命令窗口,得到一个执行路径在当前目录的cmd窗口,输入 nodeppt create file_name_of_your_doc 并回车,紧接着它会要求你填 标题、副标题、演讲者这些信息,完了就会基于模板在当前目录生成一个 file_name_of_your_doc.md 文档。因为后面还能修改,所以这些信息可以先随便填,不用太纠结;文件名不用包含后缀。

然后找一个你习惯的Markdown编辑器(如MarkdownPad / Smark),又或者随便一个纯文本编辑器(如Notepad++),就可以开工了。

nodePPT 基于 GFM 语法 (Github Flavored Markdown),在此基础上为了更好的支持演示效果,拓展了一些标签。

  • 关于 Markdown 的基础请回到前面的介绍
  • 关于 拓展的内容,文档生成时,已经自带了模板;更高级的用法,可以看官方的demo (nodeppt安装目录\ppts\demo.md

预览

虽然用Markdown编辑器可以看到效果,但是对于 nodePPT 拓展的标签,还有演示效果,编辑器就无能为力了。

这时打开当前路径下的 cmd 窗口,输入命令并回车 (1234 可以 换成任意本地没被占用的端口,不加-p参数默认端口为 8080)

1
nodeppt start -p 1234

这就打开了一个预览,任意在Markdown文件的修改,保存之后刷新一下浏览器就能马上看到效果。而且这个预览不仅本地可以用,局域网里任何能访问你电脑的机器,都能看到。 你甚至直接用这个功能,就可以完成一次演示

发布

然而预览功能需要执行 start 命令的窗口一直开着,当然你的电脑也不能关机。如果你想要一直提供给大家访问,或者需要在没有node.js的机器上展示,那么你就需要发布。

同样的当前路径下的cmd窗口,输入命令并回车,就可以得到不依赖node.js的html文件,然后发布在Apache服务器上,或者带到你需要演示的电脑上:

1
nodeppt release your_ppt.md -a

注意这里的文件名需要带后缀,并且推荐加上 -a 参数,把所有引用的 js 和 css 文件一起打包,免得演示时才发现缺少了文件。

写在后面

以往写教程,往往把 Why / 为什么选它 放在前面。 我不确定大家在完全不了解这个是什么东西的情况下,会不会愿意听我大条道理讲理由。 所以这次放到了后面。

当然前面也提到了一些 Markdown / nodePPT 的好处,那些也可以看做是理由,但我还是想谈谈个人的感受。

我得承认,如果你是赶一份文档,应付某个一次性的任务,Word / PowerPoint 是更好的选择。

所见即所得的编辑,能很快出一个 能用 的成果,拿去交差了,以后再也不用管。 而 带着Geek气质 的 Markdown,多少有些学习成本。


然而,如果你把这些文档,看做你的知识财产,长期地积累、管理、转化;如果你认同,我们的文档/演示 总是重复着一些关键的内容,只是场景和面向的人有所不同。 那么,你就能体会到一些好处:

  • 文档制作好之后,通过修改样式输出不同风格的文档,而不是重新制作
  • 相同内容不同需要的文档(word,pdf,ppt等),都通过一份源文件输出,而不是分别制作
  • 对纯文本的源文件,进行版本管理,可以diff每一版的修改,回退到任意版本,而不是无法管理的二进制文件
  • ……

更多效果,请参考作者写的例子

官方demo


知识共享 “署名-非商业性使用-相同方式共享” 4.0 (CC BY-NC-SA 4.0)”许可协议
本文为本人原创,采用知识共享 “署名-非商业性使用-相同方式共享” 4.0 (CC BY-NC-SA 4.0)”许可协议进行许可。
本作品可自由复制、传播及基于本作品进行演绎创作。如有以上需要,请留言告知,在文章开头明显位置加上署名(Jayce Chant)、原链接及许可协议信息,并明确指出修改(如有),不得用于商业用途。谢谢合作。
详情请点击查看协议具体内容。