Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soypat/go-presentx
golang's present tool but with code syntax highlighting
https://github.com/soypat/go-presentx
go-present golang interactive presentation syntax-highlighting
Last synced: 18 days ago
JSON representation
golang's present tool but with code syntax highlighting
- Host: GitHub
- URL: https://github.com/soypat/go-presentx
- Owner: soypat
- License: bsd-3-clause
- Created: 2020-11-07T23:40:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-08T08:21:41.000Z (over 1 year ago)
- Last Synced: 2024-10-12T09:11:26.349Z (about 1 month ago)
- Topics: go-present, golang, interactive, presentation, syntax-highlighting
- Language: CSS
- Homepage:
- Size: 515 KB
- Stars: 39
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-presentx
Go's [present tool](https://github.com/golang/tools/tree/master/cmd/present) but with code syntax highlighting. Highlighted code is editable with [some caveats](#about-the-syntax-highlighting-changes)
This is a quick and dirty implementation of [flippeeer's reddit post](https://www.reddit.com/r/golang/comments/jpugtg/today_i_presented_go_to_my_team_the_screen/). You can find a static version at [acanalis's github.io](https://acanalis.github.io/es/presentation/curso-go/go-desde-cero.html).
## Usage
Requires `go-presentx` installed and a prepared directory with `./templates` and `./static` folder. You may clone this repo and run `go-presentx` in the directory to be up and running on [127.0.0.1:3999](http://127.0.0.1:3999/). Go to `slides` link and open a `.slide` file to start a presentation.
You can serve the presentation on the internet configuring `-orighost` flag to your public domain. You may have to configure websockets if using a reverse-proxy like NGINX.
## Installation
See [releases](https://github.com/soypat/go-presentx/releases) executables for windows/linux/mac binaries.
To install from source: the following commands will generate an executable tool for your OS and architecture. Requires Go
```console
git clone https://github.com/soypat/go-presentx.git
cd go-presentx
go install
```
`go-presentx` shall be installed to your `$GOPATH/bin`. Add this directory to your `PATH` to be able to call `go-presentx` from console.
### Development
* Requires Go installed. Enable modules with `go env -w GO111MODULE="on"`
Start presentation on [127.0.0.1:3999](http://127.0.0.1:3999/) (default) by running:
```console
go run .
```
## About the syntax highlighting changes
* No auto-rendering while editing
* Uses the lightweight [prism.js](https://prismjs.com/) for syntax highlighting
* Change code style by replacing `static/prism.css` with one from prism.js' site and modifying it to fit your needs (see [css config section](#prism-css-config))
* Press CTRL while in editable code block to re-render all syntax
* Issue with the caret being invisible at times and sometimes appearing to be on the next line
## Prism CSS config
* Ligatures off by default. You may enable them in `prism-github-dark.css` by setting `"calt"` to `on` (see comment).
Non-default settings listed:
```css
pre[class*="language-"] {
caret-color: #ccc;
font-size: 0.95em;
border-radius: 7px;
line-height: 1.2;
}
pre[class*="language-"] {
padding: 0.6em;
}
```
## Contributing, License and authors
PRs welcome. I'll look at issues, I'll try to be nice.
idk, [same license as Go](https://github.com/golang/go/blob/master/LICENSE) I guess. Credit to **[The Go Authors.](https://github.com/golang/go/blob/master/AUTHORS)**