Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ysugimoto/resumify
Capture screenshot and make PDF on your HTML presentation.
https://github.com/ysugimoto/resumify
capture-screenshots html-presentation nodejs pdf screenshot slide talkie
Last synced: 17 days ago
JSON representation
Capture screenshot and make PDF on your HTML presentation.
- Host: GitHub
- URL: https://github.com/ysugimoto/resumify
- Owner: ysugimoto
- License: mit
- Created: 2016-01-20T00:29:39.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-12-23T14:00:23.000Z (almost 6 years ago)
- Last Synced: 2024-08-01T00:56:00.147Z (3 months ago)
- Topics: capture-screenshots, html-presentation, nodejs, pdf, screenshot, slide, talkie
- Language: JavaScript
- Size: 42 KB
- Stars: 28
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# resumify
Capture screenshot and make PDF on your HTML presentation.
## Requirements
- `node.js`: main program ( recommend 4.2.x, at least 4.x )
- `electron`: Capturing screenshot ( this package has dependency installtion `electron-prebuilt` )
- `ImageMagick`: PDF creation ( install and set PATH )
## Installation
Use `npm` simply, we recommend global install:
```
$ npm install -g resumify
```
## Usage
### 1. Local Presentation
Change to directory to slide-HTML file existing, run the command:
```
$ cd /path/to/presentation/
$ resumify
```
`resumify` will auto detecting HTML file, and processing.
### 2. Remote Presentation
If slide has remote server (e.g. AWS S3), supply URL with `-u` or `--url` option:
```
$ resumify -u http://example.com/path/to/presentation/index.html
```
Note that URL must be fully format ( including .html ).
## Options
`resumify` has some options to manage processing:
| option | description | default |
|---------------|-----------------------------------------------------|-----------|
| -t, --type | Slide control type. Can accepts `url` or `scroll`. | url |
| -s, --size | Capture screen size with `[width]x[height]` format. | 1280x800 |
| -s, --size | Capture screen size with `[width]x[height]` format. | 1280x800 |
| --skip | Skip capturing slide number like `2,3,4,...` format | - |
| -e, --end | End of slide number | 1 |
| -u, --url | Remote slide URL | - |
| -h, --help | Show help | - |
| -v, --version | Show program version | - |
| -o, --output | Determine output PDF filename | slide.pdf |
### Slide Type
The new option of `-t, --type`, which is determine how slide is controlled.
If type is `url`, slide will move by URL hash like `#1`, `#2`, ...
Other type is `scroll`, slide will move by page scrolling.
## Author
Yoshiaki Sugimoto
## License
MIT