|
1 |
| -# nlcst-affix-emoticon-modifier [](https://travis-ci.org/wooorm/nlcst-affix-emoticon-modifier) [](https://codecov.io/github/wooorm/nlcst-affix-emoticon-modifier) |
| 1 | +# nlcst-affix-emoticon-modifier [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov] |
2 | 2 |
|
3 | 3 | Move initial emoticons into the previous sentence. Useful because many people
|
4 | 4 | place an emoticon, representing emotion related to the previous sentence, after
|
5 | 5 | a terminal marker. :unamused:
|
6 | 6 |
|
7 |
| -Implemented by [retext-emoji](https://github.com/wooorm/retext-emoji), but |
8 |
| -separated for use by standalone (non-[retext](https://github.com/wooorm/retext)) |
9 |
| -processing. |
| 7 | +Implemented by [**retext-emoji**][retext-emoji], but separated for use by |
| 8 | +standalone (non-retext) processing. |
10 | 9 |
|
11 | 10 | ## Installation
|
12 | 11 |
|
13 |
| -[npm](https://docs.npmjs.com/cli/install): |
| 12 | +[npm][]: |
14 | 13 |
|
15 | 14 | ```bash
|
16 | 15 | npm install nlcst-affix-emoticon-modifier
|
17 | 16 | ```
|
18 | 17 |
|
19 | 18 | ## Usage
|
20 | 19 |
|
21 |
| -```javascript |
| 20 | +```js |
22 | 21 | var affixEmoticon = require('nlcst-affix-emoticon-modifier');
|
23 | 22 | var emoticon = require('nlcst-emoticon-modifier');
|
24 | 23 | var inspect = require('unist-util-inspect');
|
@@ -59,25 +58,32 @@ RootNode[1]
|
59 | 58 |
|
60 | 59 | ## API
|
61 | 60 |
|
62 |
| -### affixEmoticonModifier(paragraph) |
| 61 | +### `affixEmoticon(paragraph)` |
63 | 62 |
|
64 | 63 | Merge affix emoticons into the previous sentence.
|
65 | 64 |
|
66 |
| -**Parameters** |
| 65 | +###### Parameters |
67 | 66 |
|
68 | 67 | * `paragraph` ([`NLCSTParagraphNode`](https://github.com/wooorm/nlcst#paragraphnode)).
|
69 | 68 |
|
70 |
| -**Throws** |
| 69 | +## License |
71 | 70 |
|
72 |
| -* `Error` — When not given a parent node. |
| 71 | +[MIT][license] © [Titus Wormer][author] |
73 | 72 |
|
74 |
| -## Related |
| 73 | +<!-- Definitions --> |
75 | 74 |
|
76 |
| -* [nlcst](https://github.com/wooorm/nlcst); |
77 |
| -* [nlcst-emoji-modifier](https://github.com/wooorm/nlcst-emoji-modifier); |
78 |
| -* [nlcst-emoticon-modifier](https://github.com/wooorm/nlcst-emoticon-modifier); |
79 |
| -* [retext](https://github.com/wooorm/retext). |
| 75 | +[travis-badge]: https://img.shields.io/travis/wooorm/nlcst-affix-emoticon-modifier.svg |
80 | 76 |
|
81 |
| -## License |
| 77 | +[travis]: https://travis-ci.org/wooorm/nlcst-affix-emoticon-modifier |
| 78 | + |
| 79 | +[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/nlcst-affix-emoticon-modifier.svg |
| 80 | + |
| 81 | +[codecov]: https://codecov.io/github/wooorm/nlcst-affix-emoticon-modifier |
| 82 | + |
| 83 | +[npm]: https://docs.npmjs.com/cli/install |
| 84 | + |
| 85 | +[license]: LICENSE |
| 86 | + |
| 87 | +[author]: http://wooorm.com |
82 | 88 |
|
83 |
| -[MIT](LICENSE) © [Titus Wormer](http://wooorm.com) |
| 89 | +[retext-emoji]: https://github.com/wooorm/retext-emoji |
0 commit comments