search

thephpleague / html-to-markdown

Convert HTML to Markdown with PHP
MIT License
1.77k stars 205 forks source link

README incorrectly specifies default italic_style as asterisk #111

Closed IllyaMoskvin closed 7 years ago

IllyaMoskvin commented 7 years ago

The "Style options" section in the README states that:

Bold and italic tags are converted using the asterisk syntax by default.

But as of 4.1.0 (#58 and #59), italics are converted using underscore characters by default.

The README should be changed to reflect this development.

As an aside, I'm not sure that the phrasing "underlined syntax" is accurate. Wouldn't it be more accurate to call it "underscore syntax"? Sorry, not trying to be pedantic, just looking to avoid confusion with "syntax for underline". I'm not sure what the established terminology is in this case. I think the example makes it clear in either case.

colinodell commented 7 years ago

Good call! If you'd like to submit a PR for that I'd happily merge it in :)