https://github.com/slidesk/slidesk
Speaker companion
https://github.com/slidesk/slidesk
bun slideshow
Last synced: 3 months ago
JSON representation
Speaker companion
- Host: GitHub
- URL: https://github.com/slidesk/slidesk
- Owner: slidesk
- License: mit
- Created: 2023-04-04T21:23:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-14T16:05:42.000Z (about 1 year ago)
- Last Synced: 2024-05-15T14:24:04.600Z (about 1 year ago)
- Topics: bun, slideshow
- Language: TypeScript
- Homepage: https://slidesk.github.io/slidesk/
- Size: 27.7 MB
- Stars: 47
- Watchers: 1
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SliDesk
A complete documentation is available here: https://slidesk.github.io/slidesk-doc/
Write your talk/presentation in Markdown, generate it and visualize it in Web.
SliDesk is a new talk engine like RevealJS developped with [Bun](https://bun.sh).
The `example` rendering is visible on [slidesk.github.io/slidesk/](https://slidesk.github.io/slidesk/).
Plugins & Components can be found here : https://github.com/slidesk/slidesk-extras
A VSCode extension is available too : https://github.com/slidesk/vscode-sdf-language
## How to use?
### macOS with **Homebrew**
#### Installation
```sh
brew tap gouz/tools && brew install slidesk
```
or
```sh
brew install gouz/tools/slidesk
```
### Docker
Slidesk now has a DockerHub repository ! https://hub.docker.com/r/gouz/slidesk
To use it with your current working directory as your slidesk directory
```sh
docker run -it -v "$(pwd)"/:/slidesk/ -p 1337:1337 gouz/slidesk:latest
```
Slidesk is now accessible through http://localhost:1337. If you need additional arguments, specify them after specifying the slidesk binary.
Example :
```sh
docker run -it -v "$(pwd)"/:/slidesk/ -p 1337:1337 gouz/slidesk:latest slidesk -tn
```
### Other systems
If you want to compile **SliDesk**, you must have **Bun** installed on your computer.
If not, you can install it through:
```sh
curl -fsSL https://bun.sh/install | bash
```
Then you can use it through:
```sh
Usage: bunx slidesk [options] [command]
Your presentation companion
Arguments:
talk the directory of your talk
Options:
-v, --version output the version number
-d, --domain domain (default: "localhost")
-p, --port port (default: 1337)
-s, --save save the presentation
-n, --notes open with speakers notes
-t, --timers add checkpoint and slide maximum time on notes view
-a, --transition transition timer (default: 300)
-w, --watch watch modification of files
-g, --hidden remove help information
-c, --conf use a specific .env file (default: "")
-o, --open open a browser with the presentation or notes view (browser is : chrome, edge, firefox, browser, browserPrivate)
-h, --help display help for command
Commands:
create
```
## How to build SliDesk?
Once you clone the repository, you can install the dependencies with:
```sh
bun install
```
And create the "exe" file with:
```sh
bun make:exe
```
Then you'll have a `exe/slidesk` file created.
You can also use Gitpod :
[](https://gitpod.io#https://github.com/slidesk/slidesk/-/tree/main/)
## Why a new tool???
I decided to create my own tool for my talks, because:
- It's fun to create something
- I want to have a tool which do only the minimum
- I want a very tiny light tool
- I want it to be permissive a lot (you can add html tags in without any problem)