From 1582460b28ff85da8adf3bd6ab86c4ad528da250 Mon Sep 17 00:00:00 2001 From: Peter Kurfer Date: Tue, 15 Mar 2022 17:05:47 +0100 Subject: [PATCH] Add emoji section to Readme --- README.md | 17 ++++++++++++----- Taskfile.yml | 8 +++++--- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9d80596..e9ea545 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,14 @@ [![Actions Status](https://github.com/baez90/goveal/workflows/Go/badge.svg)](https://github.com/baez90/goveal/actions) Goveal is very small and very simple tool that reads Markdown from a given file, renders it into an HTML template and serves it as local HTTP server. -Right now Goveal uses Reveal.js 4.2.1 to create presentations and therefore also includes all features of Reveal.js 4.2.1. +Right now Goveal uses Reveal.js 4.3.0 to create presentations and therefore also includes all features of Reveal.js. In contrary to Reveal.js `goveal` ships with its own Markdown parser and renderer which is why some features are working slightly different from Reveal.js. See [Markdown](#markdown) for further details. Besides all features from Reveal.js `goveal` comes with first class support for [mermaid-js](https://mermaid-js.github.io/). Just inline your diagrams as code and enjoy! +An example can be found in the [examples](examples/slides.md). ## Install @@ -42,7 +43,7 @@ goveal serve ./slides.md ``` | Param | Description | Default value | -| ---------------- | --------------------------------------------- | ----------------------- | +|------------------|-----------------------------------------------|-------------------------| | `--host` | Hostname the binary is listening on | `127.0.0.1` | | `--port` | Port the binary is listening on | `2233` | | `--config` | Path to the config file see [config](#config) | `$HOME/goveal:./goveal` | @@ -58,7 +59,7 @@ this: podman/docker run --rm -ti -v `pwd`:/work -w /work -p 2233:2233 ghcr.io/baez90/goveal:0 serve --host 0.0.0.0 slides.md ``` -By default `goveal` only listens on `127.0.0.1`. To allow traffic from outside of the container you've to change the +By default `goveal` only listens on `127.0.0.1`. To allow traffic from outside the container you've to change the binding to `0.0.0.0`. ## Config @@ -78,7 +79,7 @@ I try to keep the example up to date to cover **all** supported config options a ## Markdown A good point to start is the [slides.md](examples/slides.md) in the `examples` directory. -I try to showcase everyting possible with `goveal` in this presentation. +I try to showcase everything possible with `goveal` in this presentation. The most remarkable difference between `goveal` and the `marked` driven Reveal.js markdown is how line numbers in listings are working: @@ -114,4 +115,10 @@ Changes in the custom CSS files are monitored and propagated via SSE to the pres No page reload necessary! The sample configuration file [`./examples/goveal.yaml`](./examples/goveal.yaml) also contains a sample how to add -custom CSS. \ No newline at end of file +custom CSS. + +## Emojis + +Aside of UTF character emojis `goveal` also supports emoji references like Github flavored markdown supports them. +For example`:winking_face:` becomes :winking_face: . +All supported keywords can be found [here](https://unpkg.com/emojilib@latest). \ No newline at end of file diff --git a/Taskfile.yml b/Taskfile.yml index bb56878..9a9bc46 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -2,8 +2,8 @@ version: '3' vars: DEBUG_PORT: 2345 - REVEALJS_VERSION: 4.2.1 - HIGHLIGHTJS_VERSION: 11.4.0 + REVEALJS_VERSION: 4.3.0 + HIGHLIGHTJS_VERSION: 11.5.0 MERMAID_VERSION: 8.14.0 BINARY_NAME: goveal OUT_DIR: ./out @@ -33,6 +33,8 @@ tasks: - "{{ .GOBIN }}goimports -w -local github.com/baez90/goveal ./." deps: + deps: + - download-assets sources: - go.mod - go.sum @@ -99,7 +101,7 @@ tasks: - rm -f ./assets/reveal/plugin/menu/{bower.json,CONTRIBUTING.md,LICENSE,package.json,README.md,.gitignore,gulpfile.js,package-lock.json} - curl -L https://github.com/highlightjs/highlight.js/archive/{{ .HIGHLIGHTJS_VERSION }}.tar.gz | tar -xvz --strip-components=3 -C ./assets/reveal/plugin/highlight --wildcards "*.css" highlight.js-{{ .HIGHLIGHTJS_VERSION }}/src/styles/ - curl -L https://registry.npmjs.org/mermaid/-/mermaid-{{ .MERMAID_VERSION }}.tgz | tar -xvz -C ./assets/mermaid/ package/dist --strip-components=2 - - curl -L -o rendering/emoji/emoji.json https://raw.githubusercontent.com/muan/emojilib/main/dist/emoji-en-US.json + - curl -L -o rendering/emoji/emoji.json https://unpkg.com/emojilib@latest go-get-tool: vars: