Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henrixounez/termslides
Add terminals into you reveal.js presentations
https://github.com/henrixounez/termslides
Last synced: 29 days ago
JSON representation
Add terminals into you reveal.js presentations
- Host: GitHub
- URL: https://github.com/henrixounez/termslides
- Owner: Henrixounez
- Created: 2018-12-12T07:17:34.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T08:49:47.000Z (about 2 years ago)
- Last Synced: 2023-03-08T19:22:46.567Z (almost 2 years ago)
- Language: HTML
- Size: 2.37 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TermSlides
Add terminals into you reveal.js presentations
## Pre-Installation :
- You will need those package to run the install :
- npm
- node
## Installation Reveal.js and Xterm.js dependencies :
```
git clone https://github.com/Henrixounez/TermSlides.git
cd TermSlides
npm install
cd node_modules/xterm/
npm install
```
## How to use :
- Create a slide on Slides.com
- Add in your slide HTML :
```
```
- Export your file in HTML
- Use termslides.js to convert your terminal divs into real terminals
```
node termslides.js
```
- Then you can start reveal.js in root folder using
```
npm run start
```
- Enjoy !
- You can access your slide using http://127.0.0.1:8000/\
- You can try right now, an HTML Slide is available to test (demo.html)
## Customization :
- You can change default shell by modifying this line in app.js :
```
var entrypoint = process.platform === 'win32' ? 'cmd.exe' : 'bash'; //You can change to your favorite shell here
```
### Optional div attributes :
* data-cwd="\"
- Spawns terminal in designated folder
* data-cmd="\"
- Terminal execute a command on spawn
* data-cmd-nowrite="\"
- Write a command on spawn without executing it
* data-display="none"
- Terminal will spawn collapsed
* data-cols="\"
- Terminal columns number
* data-rows="\"
- Terminal rows number
* data-fontsize="\"
- Terminal font size
----
## Based of the work made by :
- Reveal.js: https://github.com/hakimel/reveal.js/
- Xterm.js : https://github.com/xtermjs/xterm.js/
- Terminal implementation : https://github.com/jkinkead/reveal.js/tree/xterm_base
- Terminal styles : https://github.com/krasimir/evala