Skip to content

Update documentation for softbreak option #118

@timkingman

Description

@timkingman

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions