Installization

1
$ npm install -g nodeppt

if you are mac user…

1
$ sudo npm install -g nodeppt --unsafe-perm=true --allow-root

Usage

1
2
3
4
5
6
7
8
9
10
11
# create a new slide with an official template
$ nodeppt new slide.md

# create a new slide straight from a github template
$ nodeppt new slide.md -t username/repo

# start local sever show slide
$ nodeppt serve slide.md

# to build a slide
$ nodeppt build slide.md

Speaker mode

nodeppt has a speaker mode, just add ?mode=speaker after the url.

Keyboard Shortcuts

  • Page: ↑/↓/←/→ Space Home End
  • Fullscreen: F
  • Overview: -/+
  • Speaker Note: N
  • Grid Background: Enter

public resources：public folder

如果項目文件夾下，存在public文件夾，可以直接通過 url 訪問，參考webpack dev server的 contentBase 選項。

在build的時候，public 文件夾中的文件會完全 copy 到dist文件夾中

编写

Use Chrome for best experience.

Syntax

整個 markdown 文件分為兩部分，第一部分是寫在最前面的Configuration，然後是使用<slide>隔開的每頁幻燈片內容。

Configuration

nodeppt 的配置是直接寫在 md 文件頂部的，采用 yaml 語法，例如下面配置：

1
2
3
4
5
6
7
8
9
10
title: 
speaker: 
url: 
js:
    - https://www.echartsjs.com/asset/theme/shine.js
prismTheme: solarizedlight
plugins:
    - echarts
    - mermaid
    - katex
  • title: 演講主題
  • speaker：演講者
  • url：地址
  • js：js 文件數組，放到 body 之前
  • css：css 文件數組，放到頭部
  • prismTheme：prism 配色，取值範圍 ['dark', 'coy', 'funky', 'okaidia', 'tomorrow', 'solarizedlight', 'twilight']
  • plugins：目前支持 echarts，mermaid和 katex 三個插件

Reference1
Reference2