v2.1.0

New features:

• alphabetic decorator can be configured to place certain blocks as intro or outro
• match also full block names when a name map is configured

Bug fixes:

• omit source link in alias blocks
• give precedence to longer block name matches

v2.0.0

Breaking changes:

• earmark meaning has changed: it is not part of the name anymore and is @ by default
• names option provides a way to filter included doc blocks by name in the way earmark did in v1.
• equally 4-space indented paragraphs are now treated as preformatted code block. #13

Improvements:

• more robust signature line handling #31
• prettier lists #24
• better usage docs

v1.6.0

New features:

• names can be prefixed with @ or one or many # symbols. Purely optional and does not affect doc output.

Bug fixes:

• correct block sorting order when using alphabetical decorator with groupCase true.

Other improvements:

• alias blocks only link to the primary block to prevent reader wandering from alias to alias.
• upgraded dependency: marked 4.1.0 --> 4.2.3

v1.5.0

New features:

• #20 Customizable title line for table of contents.
• #17 Add option to group namespace members based on their letter case. This allows constants become before methods, for example.
• #14 #15 Support multiple block earmarks and allow abbreviated earmarks for conveniency.
• #22 Remove large gap between list titles and list items

Bugfixes:

• #19 prevent table of contents list merging with a list before the toc.

Other changes:

• improved test suite
• small improvements to docs
• added new dependency: marked

v1.4.0

New features:

• allow space, hash, and slash to act as block name separator
• allow hash prefix before block name
• depth limit for the ToC decorator
• parse nameParts and render names as a set of links

Other changes:

• make lowercase hash URLs
• updated logo
• add list of related tools to README
• slightly improved docs

v1.3.1

Bug fixes:

• correct decorators.sourceLinks documentation
• allow colon, hash, and slash be part of the block name
• allow preformatted text sections have empty lines
• protect preformatted text sections from decorators

v1.3.0

New features:

• linkKeywords decorator to help creating links for keywords

Bug fixes:

• repair alias yamdog.stringify

v1.2.1

Changes:

• fixed a bug where commented-out imports and requires were treated as uncommented ones
• corrected Usage docs in readme
• improved documentation and project structure

v1.2.0

New features:

• decorators: alphabetical, backTopLinks, replaceListValues, italicSingles
• back-to-top link was removed from render method in favour of backTopLinks decorator

Fixes:

• correct docs for decorator.aliases

v1.1.0

New features:

• parse multiple block signatures to define aliases
• capture associated source code file path for each block during parsing
• parsed blocks have new properties: file, hash, aliases
• decorators: aliases, sourceLinks, toc
• improve linkNames decorator: link longest names first, link all instances
• setup GitHub Pages

Bug fixes:

• include last block text line even when the next line is a code line