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.

Sign up for GitHub

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

Jump to bottom

Update documentation for softbreak option #118

Closed

timkingman opened this issue May 26, 2017 · 0 comments

timkingman commented May 26, 2017

README says:

var writer = new commonmark.HtmlRenderer;
writer.softbreak = "<br />";

but that results in errors.
From the source, it looks like the softbreak replacement string should be passed in as a constructor option

var writer = new commonmark.HtmlRenderer({softbreak: "<br />"});

So softbreak could be listed with the other HtmlRenderer constructor options immediately above this example.

jgm closed this as completed in

4edcf02

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment