Writing remark slides with conversational (Tw)emoji within Hugo
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
archetypes
exampleSite
images
layouts
static
LICENSE.md
README.md
theme.toml

README.md

hugo-remark-twemoji

This template is for authoring remark slides featuring conversational (Tw)emoji within Hugo.

Remark is a flexible and powerful HTML presentation framework which renders nicely markdown content. This project is an attempt to manage content entirely with Hugo, featuring Twitter Emoji (Twemoji) conversational templates.

Preview of the available twemoji can be seen here. This project utilizes twemoji-awesome CSS interface. Emoji names are mostly (claimed) to be compatible with Emoji cheat sheet.

Screenshot

Demo

Installation

Inside the folder of your Hugo site run:

$ cd themes
$ git clone https://github.com/eueung/hugo-remark-twemoji.git remark-twemoji

For more information read the official setup guide of Hugo.

Sample Configuration

The following config.toml is used for the demo site mentioned above.

baseurl         = "/"
theme           = "remark-twemoji"
languageCode    = "en-us"
title           = "Site Title | Hugo Remark-Twemoji"
canonifyurls    = true

[params]
  googleAnalytics = ""
  name            = "Eueung Mulyana"
  description     = "Demo slides for Hugo Remark Twemoji"
  custom_css      = ["custom.css"]

Sample Content

Sample content structure is given in the exampleSite folder. Because of the current (v0.18) implementation of .RawContent which does not render Hugo shortcode, page variable contentType must be set to sc (abbreviated shortcode), otherwise it has to be set to md (markdown). The above screenshot was produced with the following source.

+++
contentType = "sc"
weight = 26
+++

{{< twemoji_right title="#Learn" emoji="owl" >}}
Always learn something new ..
{{< /twemoji_right >}}

Sample Style

Usually you'll maintain your own custom CSS. This has to be declared in the config.toml. Sample style is included in the exampleSite/static/css folder.

Have fun!

License

This theme is released under the MIT license. For more information read the License.