{"id":13469942,"url":"https://github.com/yusukebe/revealgo","last_synced_at":"2026-03-02T22:13:06.613Z","repository":{"id":44667037,"uuid":"50418895","full_name":"yusukebe/revealgo","owner":"yusukebe","description":"Markdown driven presentation tool written in Go!","archived":false,"fork":false,"pushed_at":"2024-02-06T11:51:08.000Z","size":4913,"stargazers_count":239,"open_issues_count":7,"forks_count":22,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-02T08:12:44.672Z","etag":null,"topics":["golang","keynote","markdown","presentation","revealjs","slides"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yusukebe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-26T09:39:39.000Z","updated_at":"2025-03-25T20:13:11.000Z","dependencies_parsed_at":"2024-05-28T07:37:36.234Z","dependency_job_id":null,"html_url":"https://github.com/yusukebe/revealgo","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusukebe%2Frevealgo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusukebe%2Frevealgo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusukebe%2Frevealgo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusukebe%2Frevealgo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yusukebe","download_url":"https://codeload.github.com/yusukebe/revealgo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248027407,"owners_count":21035594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","keynote","markdown","presentation","revealjs","slides"],"created_at":"2024-07-31T16:00:19.323Z","updated_at":"2026-03-02T22:13:06.568Z","avatar_url":"https://github.com/yusukebe.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# revealgo\n\n**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.\n\n## Installation\n\n### Binary\n\nDownload 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.\n\n### Homebrew\n\nYou can also install via [hombrew](https://brew.sh) on macOS:\n\n```\n$ brew install yusukebe/tap/revealgo\n```\n\n### Source\n\nTo install from the source, use `go install` after `git clone`:\n\n```\n$ git clone git@github.com:yusukebe/revealgo.git\n$ cd revealgo\n$ git submodule update --init --recursive\n$ go install ./cmd/revealgo\n```\n\n## Usage\n\nThe usage:\n\n```\n$ revealgo [options] MARKDOWN.md\n```\n\nThen access the local web server such as `http://localhost:3000` with Chrome, Firefox, or Safari.\n\nAvailable options:\n\n```text\n-p, --port            TCP port number of this server (default: 3000)\n--theme               Slide theme or original css file name. default themes:\n                      beige, black, blood, league, moon, night, serif, simple, sky, solarized, and white (default: black.css)\n--transition          Transition effect for slides: default, cube, page, concave, zoom, linear, fade, none (default: default)\n--separator           Horizontal slide separator characters (default: ^---)\n--vertical-separator  Vertical slide separator characters (default: ^___)\n--multiplex           Enable slide multiplex\n```\n\n### Screenshots\n\nRun `revealgo` command:\n\n![Command Line](https://cloud.githubusercontent.com/assets/10682/12741641/b5afb504-c9c1-11e5-94d6-c364912cfcc2.png)\n\nOpen the server address with your web browser:\n\n![Slides](https://cloud.githubusercontent.com/assets/10682/12741672/f9cda548-c9c1-11e5-9c21-fcaf1af3cdf4.png)\n\n### Sample Makrdown\n\n```text\n## This is an H2 Title\n\nDescription...\n\nThe horizontal slide separator characters are '---'\n\n---\n\n# This is second title\n\nThe vertical slide separator characters are '^___'\n\n___\n\n## This is a third title\n\n---\n\n## This is a forth title\n\n\u003c!-- .slide: data-background=\"#f70000\" data-transition=\"page\" --\u003e\n\nYou can add slide attributes like above.\n```\n\n### Customize Theme\n\nWhile `revealgo` is running, open another terminal and get the theme file `black.css`:\n\n```\n$ curl http://localhost:3000/revealjs/css/theme/black.css \u003e original.css\n```\n\nEdit `original.css`, And then run `revealgo` with `--theme` option:\n\n```\n$ revealgo --theme original.css slide.md\n```\n\n### Customize Slide Configurations\n\nGet the default slide HTML file:\n\n```\n$ curl http://localhost:3000/ \u003e slide.html\n```\n\nEdit `slide.html`, and then open `http://localhost:3000/slide.html` with your browser. A slide with the modified configurations will come up.\n\n### Using slide multiplex\n\n\u003e The multiplex plugin allows your audience to follow the slides of the\n\u003e presentation you are controlling on their own phone, tablet or laptop\n\u003e\n\u003e --- [reveal.js site](https://revealjs.com/multiplex/)\n\nWhen `--multiplex` is enabled, the client slides can be found on the `/` path and\nthe master ones under `/master/`. The master presentation will push its changes\nto all the client ones for every transition, is like having a remote control!\n\nFor example, your laptop's IP address in the local network is `192.168.100.10`\nand you are using the port `3000`, so your audience should see the slides on\n`http://192.168.100.10:3000/`, and you should be able to control their slides\nthrough `http://192.168.100.10:3000/master/`.\n\n**NOTE**: Bear in mind multiplex feature will not work as expected when 1) the\npresenter computer firewall denies incomig traffic or 2) the local network\ndoes not allow traffic between devices on the port you picked\n\n## Related projects\n\n- reveal.js \u003chttps://github.com/hakimel/reveal.js/\u003e\n- App::revealup \u003chttps://github.com/yusukebe/App-revealup\u003e\n- reveal-md \u003chttps://github.com/webpro/reveal-md\u003e\n\n## Contributing\n\nSee [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md).\n\n## Contributors\n\nThanks to all [contributors](https://github.com/yusukebe/revealgo/graphs/contributors)!\n\n## Author\n\nYusuke Wada \u003chttp://github.com/yusukebe\u003e\n\n## License\n\nDistributed under the MIT License. See [LICENSE](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusukebe%2Frevealgo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyusukebe%2Frevealgo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusukebe%2Frevealgo/lists"}