ember-smart-format v0.0.5
ember-smart-format
Important
Please, if you are using this addon to markdown your text, consider using something else like ember-cli-markdownit, ember-showdown. They are more robust, comply with a popular standard, have greater support, and most important: they are less likely to have security/performance issues. This addon relies heavily on regex and it implements its own tags. Stick with some popular standard.:)
What is this addon?
Ember addon to convert parts of your text that are using smart tags to valid html blocks.
Installation
ember install ember-smart-format
Usage
{{smart-format text='The quick fox **jumps** over the lazy dog'}}
Output: The quick fox jumps over the lazy dog
Simple tags:
Syntax | Output |
---|---|
**text** | <b>text</b> |
#text | <h3>text</h3> |
code languagemy code/code | <pre><code class="language">my code</code></pre> |
img myimg | <img src="${media}myimg" class="img"> |
outimg myimg | <img src="myimg" class="img"> |
caption mycaption | <figcaption class="figure-caption">mycaption</figcaption> |
link text|url | <a href="url">text</a> |
More complex tags:
Example 1 (you can also use ol
instead of ul
):
[ul]*item1
*item2
*item3[/ul]
Output 1:
- item1
- item2
- item3
Example 2:
[table] |header1| |header2|
|col1| |col2| [/table]
Output 2:
header1 | header2 |
---|---|
col1 | col2 |
Configuration
This addon uses ember-highlightjs-shim to format code blocks. Read more on how to pick a theme in their documentation.
Right now the only configuration you can have besides for the <code> tags,
is for your <img> tags. By default it appends the path/name you use in
img path/name to your root url, but if you want to use a different source for
your images, or have a namespace for your path you can add the following in your
config/environment.js
let ENV = {
...
'smartFormat': {
'media': '/my-image-repository/';
}
...
}
So when using img 01-01-2018/fireworks.png will show <img src="/my-image-repository/01-01-2018/fireworks.png">
Issues/Suggestions
If you have any question or suggestion, please open an issue.
Development
git clone https://github.com/rennomarcus/ember-smart-format.git
ember s
Tests
ember test
orember s
and go to /tests