https://github.com/kt3k/emoji-gen

:dog: :mouse: :alien: Create your own set of `emoji`s from your images.
https://github.com/kt3k/emoji-gen

Last synced: 20 days ago
JSON representation

:dog: :mouse: :alien: Create your own set of `emoji`s from your images.

• Host: GitHub
• URL: https://github.com/kt3k/emoji-gen
• Owner: kt3k
• License: mit
• Created: 2016-05-21T11:02:04.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-03-07T11:45:31.000Z (over 4 years ago)
• Last Synced: 2024-10-04T19:20:35.290Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 30.3 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# emoji-gen v1.0.3

[![CircleCI](https://circleci.com/gh/kt3k/emoji-gen.svg?style=svg)](https://circleci.com/gh/kt3k/emoji-gen)

[![codecov](https://codecov.io/gh/kt3k/emoji-gen/branch/master/graph/badge.svg)](https://codecov.io/gh/kt3k/emoji-gen)

> Create your own set of 'emoji's from your images.

# Features

- `emoji-gen` is command line tool written in node.js.

- This creates stylesheet (`.css`) file from the command line.

- You need to prepare your own images which you want to use as *emoji symbol* (like :dog: :mouse: :alien: )

- With the generated css, you can use emoji in your markup files (`.html`) like ``.

  - See below for details.

  - See [demo][demo] for what it looks like.

# Install

    npm install -g emoji-gen

This installs `emoji-gen` command globally. You can check the installation by hitting the command:

    emoji-gen --help

# Usage

`emoji-gen` command creates css file from the glob pattern of image files.

Suppose you have following dir structure and image files:

    site/

    └── img/

        ├── bar.svg

        ├── baz.svg

        └── foo.svg

Then do this:

    emoji-gen "site/img/**/*.svg" -o site/css/emoji.css

Then you have:

    site/

    ├── css/

    │   └── emoji.css

    └── img/

        ├── bar.svg

        ├── baz.svg

        └── foo.svg

The above command creates `site/css/emoji.css` and you can use the following markups in html with it:

```html

...

Hello, this is my emoji  !

```

In the above `` part is rendered like *emoji*!

See the [demo][demo].

The following classes are included in the generated css:

- `.emoji`

  - This defines the basic dimension of emoji character.

- `.emoji-20`

- `.emoji-22`

- `.emoji-25`

- `.emoji-30`

  - These define the basic dimension of emoji character with the specific sizes.

- `.emoji-foo`

- `.emoji-bar`

- `.emoji-baz`

  - These define each emoji character.

# Command options

You can specify the following options in the command:

- `--class` You can specify class name for each css class. Default is `emoji`.

- `--output` You can specify output file path. This is required.

- `--size` The sizes of emoji classes. If you set `--size 20,30,40`, then you have `emoji-20` `emoji-30` and `emoji-40` classes. Default is `20,22,25,30`.

- `--default-size` The default size of emoji. Default is `22`.

# Note

- This module supports node v4.x and above.

- This module doesn't create an emoji sprite.

- This module doesn't inline emoji images in the generated css.

# License

MIT

[demo]: https://kt3k.github.io/emoji-gen/demo/