Sha256: 768d26ad43a9e8729448926328b957f100d2dffb07817bd255e57fa329fe2d98

Contents?: true

Size: 1.04 KB

Versions: 1

Compression:

Stored size: 1.04 KB

Contents

# slacken

## Description
This gem translates a html source into a markup text for Slack.

## Examples

Sample input source and output texts are in `sample/`.

```
> require 'slacken'
> puts Slacken.translate(File.read('sample/source.html'))
# *Slacken*
#
# This gem translates a html source into *a markup text for Slack*.
# <http://qiita.com|Qiita> uses this gem to decorate notification messages to Slack :trollface:.
#
# *Examples*
#
# *List*
#
# 1. Item 1
# 2. _Item 2 (italic)_
#     • [x] Checked
#     • [ ] Unchecked
# 3. *Item 3 (bold)*
#     • Nested Item 1
#     • Nested Item 2
#
# *Citation*
#
# > Qiita is a technical information sharing site for programmers.
# >  Kobito is an application for technical information recording.
#
# *Source Code*
#
# ```class World
#   def hello
#     puts 'Hello, world!'
#   end
# end
# ```
#
# *Image*
#
# This is a Qiita logo.
#
# -----------
#
# <http://cdn.qiita.com/assets/siteid-reverse-1949e989f9d8b2f6fad65a57292b2b01.png|Qiita logo>
```

## Install

```
$ gem install slacken
```

## License
MIT

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
slacken-0.1.0 README.md