Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yusukebe/revealgo
Markdown driven presentation tool written in Go!
https://github.com/yusukebe/revealgo
golang keynote markdown presentation revealjs slides
Last synced: 13 days ago
JSON representation
Markdown driven presentation tool written in Go!
- Host: GitHub
- URL: https://github.com/yusukebe/revealgo
- Owner: yusukebe
- License: mit
- Created: 2016-01-26T09:39:39.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T11:51:08.000Z (9 months ago)
- Last Synced: 2024-10-19T16:57:46.247Z (25 days ago)
- Topics: golang, keynote, markdown, presentation, revealjs, slides
- Language: Go
- Homepage:
- Size: 4.69 MB
- Stars: 237
- Watchers: 8
- Forks: 22
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# revealgo
**revealgo** is a small web application for giving Markdown-driven presentations implemented in **Go**! The `revealgo` command starts a local web server to serve the your markdown presentation file with `reveal.js`. The presentation can be viewed in a web browser. The reveal.js library offers comprehensive presenting features such as slide transitions, speaker notes and more.
## Installation
### Binary
Download the binary from [**GitHub Releases**](https://github.com/yusukebe/revealgo/releases) and install it somewhere in your `$PATH`. `revealgo` currently provides pre-built binaries for Linux, macOS and Windows.
### Homebrew
You can also install via [hombrew](https://brew.sh) on macOS:
```
$ brew install yusukebe/tap/revealgo
```
### Source
To install from the source, use `go install` after `git clone`:
```
$ git clone [email protected]:yusukebe/revealgo.git
$ cd revealgo
$ git submodule update --init --recursive
$ go install ./cmd/revealgo
```
## Usage
The usage:
```
$ revealgo [options] MARKDOWN.md
```
Then access the local web server such as `http://localhost:3000` with Chrome, Firefox, or Safari.
Available options:
```text
-p, --port TCP port number of this server (default: 3000)
--theme Slide theme or original css file name. default themes:
beige, black, blood, league, moon, night, serif, simple, sky, solarized, and white (default: black.css)
--transition Transition effect for slides: default, cube, page, concave, zoom, linear, fade, none (default: default)
--separator Horizontal slide separator characters (default: ^---)
--vertical-separator Vertical slide separator characters (default: ^___)
--multiplex Enable slide multiplex
```
### Screenshots
Run `revealgo` command:
Open the server address with your web browser:
### Sample Makrdown
```text
## This is an H2 Title
Description...
The horizontal slide separator characters are '---'
---
# This is second title
The vertical slide separator characters are '^___'
___
## This is a third title
---
## This is a forth title
You can add slide attributes like above.
```
### Customize Theme
While `revealgo` is running, open another terminal and get the theme file `black.css`:
```
$ curl http://localhost:3000/revealjs/css/theme/black.css > original.css
```
Edit `original.css`, And then run `revealgo` with `--theme` option:
```
$ revealgo --theme original.css slide.md
```
### Customize Slide Configurations
Get the default slide HTML file:
```
$ curl http://localhost:3000/ > slide.html
```
Edit `slide.html`, and then open `http://localhost:3000/slide.html` with your browser. A slide with the modified configurations will come up.
### Using slide multiplex
> The multiplex plugin allows your audience to follow the slides of the
> presentation you are controlling on their own phone, tablet or laptop
>
> --- [reveal.js site](https://revealjs.com/multiplex/)
When `--multiplex` is enabled, the client slides can be found on the `/` path and
the master ones under `/master/`. The master presentation will push its changes
to all the client ones for every transition, is like having a remote control!
For example, your laptop's IP address in the local network is `192.168.100.10`
and you are using the port `3000`, so your audience should see the slides on
`http://192.168.100.10:3000/`, and you should be able to control their slides
through `http://192.168.100.10:3000/master/`.
**NOTE**: Bear in mind multiplex feature will not work as expected when 1) the
presenter computer firewall denies incomig traffic or 2) the local network
does not allow traffic between devices on the port you picked
## Related projects
- reveal.js
- App::revealup
- reveal-md
## Contributing
See [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md).
## Contributors
Thanks to all [contributors](https://github.com/yusukebe/revealgo/graphs/contributors)!
## Author
Yusuke Wada
## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.