Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

html support? #344

Closed
schnittstabil opened this issue Apr 15, 2015 · 6 comments · Fixed by #346
Closed

html support? #344

schnittstabil opened this issue Apr 15, 2015 · 6 comments · Fixed by #346
Assignees
Labels
Milestone

Comments

@schnittstabil
Copy link

Don't know if this change was on purpose, but since #321 yuidoc autoescapes html tags.

That is because the html option of markdown-it defaults to false, which can be easily fixed in a configfile:

{
  "options": {
    "markdown": {
      "html": true
    }
  }
}
@okuryu
Copy link
Member

okuryu commented Apr 16, 2015

Yeah, you need to turn to true the html option if you have a code which contains HTML like this.

/**
 * This is the <b>MyClass</b> class.
 *
 * @class MyClass
 */

This might be construed as a regression, so maybe we should change to true this option as default at YUIDoc.

@schnittstabil
Copy link
Author

I don't know much about the old behavior, but I think if it's a regression, maybe two further options should also be taken into account:

linkify:      false,        // Autoconvert URL-like text to links

// Enable some language-neutral replacement + quotes beautification
typographer:  false,

@okuryu
Copy link
Member

okuryu commented Apr 17, 2015

Thanks! We've used marked as Markdown parser previously. I've verified that turning to true the html and linkify option seems to be similar in the default behavior of marked.

But I'm not sure that we should set to true the typographer option of markdown-it. Do you have a confirmable example?

@schnittstabil
Copy link
Author

As far as I can see typographer replaces (c) with © etc. - there are some examples at https://markdown-it.github.io. But neither I know the old behavior, nor if it makes sense to change it…

I'm fine with both…

@okuryu
Copy link
Member

okuryu commented Apr 18, 2015

IMO, marked doesn't have a feature same with typographer option, but I'd like to consider to switch to true the html, linkify and typographer options.

@okuryu okuryu added this to the v0.7.0 milestone Apr 18, 2015
@okuryu okuryu added the bug label Apr 18, 2015
@okuryu okuryu self-assigned this Apr 18, 2015
okuryu added a commit to okuryu/yuidoc that referenced this issue Apr 27, 2015
It turns to `true` the `html` and `linkify` options of `markdown-it`.
This is more similar behavior with the previous Markdown parser. Fixes yui#344.
@okuryu
Copy link
Member

okuryu commented Apr 29, 2015

Published yuidocjs@0.7.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants