search

ember-learn / ember-jsonapi-docs

fixes up the ember docs generated by YUIDoc to be in JSONAPI format + some other niceties
9 stars 11 forks source link

Decode character entities given in descriptions. #63

Closed toddjordan closed 5 years ago

toddjordan commented 5 years ago

This is a patch for https://github.com/emberjs/ember.js/issues/18063 which lets us provide yuidoc special characters as html character code entities and decodes them before we apply highlightjs and markdown processing.

Here's a preview of the screen for the above issue image

jenweber commented 5 years ago

Waiting for @sivakumar-kailasam to chime in before we merge this

sivakumar-kailasam commented 5 years ago

This is exactly what I had in mind.🙏 @toddjordan could you make the test pass before merging this though?

toddjordan commented 5 years ago

@sivakumar-kailasam so husky was preventing the build from passing because it was adjusting the indentation of a switch statement in the file, so for now I'm removing husky so we can get this in.

toddjordan commented 5 years ago

if someone has a husky config that plays well with our eslint config we can re-enable it

sivakumar-kailasam commented 5 years ago

SGTM