Giter VIP home page Giter VIP logo

hugo-remark-twemoji's Introduction

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.

hugo-remark-twemoji's People

Contributors

eueung avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.