cybertoothca / ember-cli-marked-down

This addon provides a means to generate html formatted markup from markdown source. The ShowdownJS library is leveraged to generate the html and this addon has been designed to be configured at the application's `environment.js` level.

Cheat Sheets

cybertooth.io EmberJs Add-Ons Cheat Sheet

EmberJs Add-On Cheat Sheet

EmberJs Testing Cheat Sheet

Rails Error Messages Cheat Sheet

ember-cli-release Cheat Sheet

rvm (Ruby Version Manager) Cheat Sheet

nvm (Node Version Manager) Cheat Sheet

yarn Cheat Sheet

How To Documents

Ember-Data Rollback Belongs To Relationships

Ember-Data's rollbackAttributes() function will not rollback changes to your belongs-to relationships; here's a strategy to conquer that shortcoming.

EmberJs Testing In Chrome/Firefox Headless Mode By Default

Gist and explanation of enhanced testem.js configuration that runs in browser headless mode by default.

CircleCI-1.0 Configuration For Ember-2.13 Addons

Reference guide for using CircleCI-1.0's parallelism when building an add-on against multiple Ember versions.

WIKI: Rails API Server How To Documents & Best Practices

References for creating Models, Resources, Policiies, & Controllers that can be consumed effortlessly by Ember Data.

WIKI: Ember UI How To Documents And Best Practices

References for creating Ember models, routes, and using various community add-ons.

Reference/Conventions

Naming Conventions

A work-in-progress concerning ideas revolving around various naming conventions.

ember-cli-marked-down's Issues

Showdown ES6 Shim?

Include XSS Filter On All Instantiated Converters

Consider created a factory of converters that will automatically include configured extensions.

Might need to consider how to turn off extensions?

Put Demo Website Up

Support Option Configuration Through `environment.js`

Using the options from markdown, assign them to the showdown Converter singleton; here's a list as fo October 2016:

• omitExtraWLInCodeBlocks: (boolean) [default false] Omit the trailing newline in a code block.
• noHeaderId: (boolean) [default false] Disable the automatic generation of header ids. Setting to true overrides prefixHeaderId
• prefixHeaderId: (string/boolean) [default false] Add a prefix to the generated header ids. Passing a string will prefix that string to the header id. Setting to true will add a generic 'section' prefix.
• parseImgDimensions: (boolean) [default false] Enable support for setting image dimensions from within markdown syntax.
• headerLevelStart: (integer) [default 1] Set the header starting level.
• simplifiedAutoLink: (boolean) [default false] Turning this on will enable GFM autolink style.
• literalMidWordUnderscores: (boolean) [default false] Turning this on will stop showdown from interpreting underscores in the middle of words as <em> and <strong> and instead treat them as literal underscores.
• strikethrough: (boolean) [default false] Enable support for strikethrough syntax.
• tables: (boolean) [default false] Enable support for tables syntax.
• tablesHeaderId: (boolean) [default false] If enabled adds an id property to table headers tags.
• ghCodeBlocks: (boolean) [default true] Enable support for GFM code block style.
• tasklists:(boolean) [default false] Enable support for GFM takslists.
• smoothLivePreview: (boolean) [default false] Prevents weird effects in live previews due to incomplete input
• smartIndentationFix: (boolean) [default false] Tries to smartly fix indentation problems related to es6 template strings in the midst of indented code.

Create A Converter Factory

demo url in package.json

https://ember-cli.com/extending/#configuring-your-ember-addon-properties

Is The Blueprint Correct?

WTF was I doing in the blueprint? It looks like it is using the included function instead of the afterInstall function to add the bower packages? WTF? Is this working properly?

deploy.js Should Always Deploy To Production

New Helper {{marked-down "..."}}

{{marked-down "### Some markdown text"}}

Arguments

• the first parameter will be converted to html using the Markdown converter.
• override with all the showdown.js arguments: https://github.com/showdownjs/showdown#valid-options

Support Showdown Extensions From environment.js

Must include and set by default the following XSS filter:

• https://github.com/VisionistInc/showdown-xss-filter

A null/undefined Argument To The Helper Is Breaking Rendering

{{marked-down null}} is throwing a js exception.

Link Target _blank When Not URL Different Host

Consider creating a component that simply wraps some DOM and replaces all links that are not the same as the current host.

this.$('a')
  .attr('target', '_blank');

Support Showdown Flavours?

Support New Options Found In showdown-1.5

Three new options available.

Can I set up the helper to dynamically apply the named arguments? Should be do-able, then any changes to the showdown API will work after upgrading.

Don't forget to add demonstrations of overriding showdown options.

Fix Skipped Tests In 1.0

There are a handful of skipped tests in the set-links-target components test class. These skipped tests are a result of PhantomJS not being able to pull the href attribute from an anchor.

Consider using getOwner Polyfill To Support Ember Version Before 2.3

Currently using Ember.getOwner(this).resolveRegistration('config:environment'); to access the environment when obtaining Showdown configuration overrides.

See https://github.com/rwjblue/ember-getowner-polyfill

Remove ember-getowner-polyfill

Put the onus of including this on the developer or the Ember app that is before 2.3

Upgrade ember-getowner-polyfill

Having trouble running the polyfill in 1.13.0 tests. Have to explicitly import the getOwner method. That's not correct.

DEPRECATION: ember-getowner-polyfill is now a true polyfill. Use Ember.getOwner directly instead of importing from ember-getowner-polyfill [deprecation id: ember-getowner-polyfill.import]

Stop Using Bower