{"id":15503099,"url":"https://github.com/johno/ember-remarkable","last_synced_at":"2025-10-04T22:28:19.195Z","repository":{"id":23857770,"uuid":"27235855","full_name":"johno/ember-remarkable","owner":"johno","description":"Ember addon for Remarkable markdown parsing helpers and components.","archived":false,"fork":false,"pushed_at":"2017-05-01T03:37:35.000Z","size":71,"stargazers_count":26,"open_issues_count":4,"forks_count":20,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-20T07:19:33.066Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johno.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-27T17:43:48.000Z","updated_at":"2019-03-13T05:11:15.000Z","dependencies_parsed_at":"2022-09-04T07:01:15.899Z","dependency_job_id":null,"html_url":"https://github.com/johno/ember-remarkable","commit_stats":null,"previous_names":["johnotander/ember-remarkable"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fember-remarkable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fember-remarkable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fember-remarkable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fember-remarkable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johno","download_url":"https://codeload.github.com/johno/ember-remarkable/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250338495,"owners_count":21414196,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T09:12:11.465Z","updated_at":"2025-10-04T22:28:14.144Z","avatar_url":"https://github.com/johno.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ember-remarkable [![Build Status](https://travis-ci.org/johnotander/ember-remarkable.svg?branch=master)](https://travis-ci.org/johnotander/ember-remarkable) [![Ember Observer Score](http://emberobserver.com/badges/ember-remarkable.svg)](http://emberobserver.com/addons/ember-remarkable)\n\nAdd [Remarkable](https://github.com/jonschlinkert/remarkable) markdown parsing helpers and\ncomponents to your Ember app.\n\n## Installation\n\n```\nember install ember-remarkable\n```\n\n## Usage\n\n```hbs\n{{md-text\n  text        = \"# Markdown text!\"\n  typographer = true\n  linkify     = false\n}}\n```\n\n#### Options\n\noption        | type    | default | security                                             | description\n------------- | ------- | ------- | ---------------------------------------------------- | -----------\n`text`        | string  |         |                                                      | Markdown content to render\n`typographer` | boolean | `false` |                                                      | Whether to enable Remarkable's [typographer](https://github.com/jonschlinkert/remarkable#constructor) option\n`linkify`     | boolean | `false` |                                                      | Whether to enable Remarkable's [linkify](https://github.com/jonschlinkert/remarkable#constructor) option\n`html`        | boolean | `false` | :warning: [insecure](#warning-security-implications) | Whether to enable Remarkable's [html](https://github.com/jonschlinkert/remarkable#constructor) option\n`extensions`  | boolean | `true`  |                                                      | Whether to enable Remarkable's [syntax extensions](https://github.com/jonschlinkert/remarkable#constructor)\n`dynamic`     | boolean | `false` | :warning: [insecure](#warning-security-implications) | Whether to enable dynamic template rendering ([see below](#dynamic-template-rendering))\n\n\n#### Inline multi-line input\n\nWhen you provide the `text` inline, you can split it into multiple lines like this:\n\n```hbs\n\u003cdiv\u003e\n  {{md-text\n    text = \"\n# Hello world\n\nNote that you have to unindent\nthe multiline `text` content.\n    \"\n  }}\n\u003c/div\u003e\n```\n\n#### Dynamic Template Rendering\n\nBy enabling the `dynamic` option you can embed Ember components into your markdown:\n\n```hbs\n{{md-text\n  text = \"{{link-to 'Foo' 'foo'}}\"\n}}\n```\n\nThis feature is useful for implementing CMS-like functionality with Ember: it lets your Markdown content to be dynamic and Ember-driven rather than just static HTML.\n\nBut this approach is not encouraged by the Ember core team and might be deprecated in the future (though there are no plans to deprecate it as of May 2016).\n\n\n\n#### :warning: Security implications\n\nBy using the `html` and `dynamic` template options you can make your app vulnerable to [XSS](https://en.wikipedia.org/wiki/Cross-site_scripting).\n\nUse those options **only** if your Markdown content is provided by trusted team members and regular users have no way to update it.\n\n\n\n#### Syntax Highlighting\n\nThis addon uses [highlight.js](http://highlightjs.org) for syntax highlighting, in order to include it\nyou just need to use Github style [code-fencing](https://help.github.com/articles/github-flavored-markdown/).\nCurrently, only the component supports syntax highlighting.\n\n##### Excluding Highlightjs\n\nThe use of highlight.js can be disabled by adding the following option to your `config/environment.js`:\n\n```js\nremarkable: {\n  excludeHighlightJs: true\n}\n```\n    \nSetting to `true` will ensure that highlight.js won't  be included in your build.\n\n##### Custom Highlighting\n\nThe highlight function, as used by remarkable, can be overriden. To do this, create your own `md-text` component:\n\n```js\nimport MDTextComponent from 'ember-remarkable/components/md-text';\n\nexport default MDTextComponent.extend({ \n  highlight: function(str, lang) {\n     return '';\n  }\n}); \n```\n\n#### Plugins\n\nYou can pass plugins to each component instance by providing an array of [plugin functions](https://github.com/jonschlinkert/remarkable/blob/master/docs/plugins.md) in a `plugin` option. \n\n## Development\n\n### Installation\n\n* `git clone` this repository\n* `npm install`\n* `bower install`\n\n### Running\n\n* `ember server`\n* Visit your app at http://localhost:4200.\n\n### Running Tests\n\n* `ember test`\n* `ember test --server`\n\n### Building\n\n* `ember build`\n\nFor more information on using ember-cli, visit [http://www.ember-cli.com/](http://www.ember-cli.com/).\n\n## Thanks to the following\n\n* \u003chttps://github.com/jonschlinkert/remarkable\u003e\n* \u003chttp://highlightjs.org\u003e\n\n## License\n\nMIT\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n***\n\n\u003e Crafted with \u003c3 by [John Otander](http://johnotander.com)([@4lpine](https://twitter.com/4lpine)).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohno%2Fember-remarkable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohno%2Fember-remarkable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohno%2Fember-remarkable/lists"}