Skip to content

Document readme.md serious error about the options of delimiters #91

Open
@donaldtone

Description

@donaldtone

options.delimiters
Type: String
Default: ---

Open and close delimiters can be passed in as an array of strings.

Example:

// format delims as a string
matter.read('file.md', {delims: '~~~'});
// or an array (open/close)
matter.read('file.md', {delims: ['~~~', '~~~']});

the example is wrong.
it should use delimiters instead of delims.

like that:

Example:

// format delims as a string
matter.read('file.md', {delimiters: '~~~'});
// or an array (open/close)
matter.read('file.md', {delimiters: ['~~~', '~~~']});

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsUpdates and improvements to the documentation.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions