0.4.1 • Published 2 years ago
@tototoshi/markdown-presentation v0.4.1
markdown-presentation
- Repository: tototoshi/markdown-presentation
- Demo: GitHub Pages
What is this?
- This tool generates slides for a presentation from Markdown.
- You can create slides with live preview by starting a development server with the
--serve
option. - You can use j/k/up/down on the keyboard to move back and forth through the pages of the slide.
Install
$ npm install -g @tototoshi/markdown-presentation
or
$ npm install --save-dev @tototoshi/markdown-presentation
Usage
Usage: markdown-presentation [options] <filename>
Options:
-V, --version output the version number
-o, --out <out> Specify where to generate the file (default: "dist")
-p, --port <port> The port the server will listen on (default: 8080)
-w, --write Write files generated by the dev server
-s, --serve Run the dev server
-t, --theme <theme> Specify the name of theme <default|dark|blue> (default: "default")
--highlight <highlight> Specify the name of highlight.js theme (default: "default")
-h, --help display help for command
Directory Structure
The default directory structure for using this tool is as follows.
my_project
├── assets
│ └── icon.jpg
├── dist
│ ├── assets
│ │ └── icon.jpg
│ ├── index.html
│ └── main.js
└── index.md
- Put *.md with any name you like
- Write the generated files to
dist/
- Place asset files like images in
assets/
- The asset files will be copied to the
dist/
directory
- The asset files will be copied to the
Speaker notes
<!-- NOTE
This is shown as a speaker note.
Speaker notes are shown when you open a page with `?note=1` on the server.
-->
Example
- Start the development server on port 3000 and write the generated files to disk.
$ markdown-presentation --serve -p 3000 --write your_file.md --highlight rainbow
- Generate slides from markdowns, and output the generated files in the docs/ directory
$ markdown-presentation --out docs your_file.md
LICENSE
Apache 2.0
0.4.1
2 years ago
0.3.0
3 years ago
0.2.7
3 years ago
0.2.6
3 years ago
0.2.5
3 years ago
0.2.4
3 years ago
0.2.3
3 years ago
0.2.1
3 years ago
0.2.0
3 years ago
0.2.2
3 years ago
0.1.10
3 years ago
0.1.9
3 years ago
0.1.8
3 years ago
0.1.7
3 years ago
0.1.6
3 years ago
0.1.4
3 years ago
0.1.5
3 years ago
0.1.3
3 years ago
0.1.2
3 years ago
0.1.1
3 years ago
0.1.0
3 years ago