Skip to content

relizy / markdownToSlackMrkdwn

Function: markdownToSlackMrkdwn() ​

markdownToSlackMrkdwn(markdown, __namedParameters?): string

Defined in: src/core/slack-markdown.ts:399

Render a markdown changelog as Slack mrkdwn. When maxLength is exceeded, whole commits are dropped from the end and replaced with an "… and N more changes" line; a single block longer than the budget is cut instead.

Parameters ​

markdown ​

string

__namedParameters? ​

cutCommits? ​

boolean = false

Cut the first commit that does not fit where the limit is reached, instead of dropping it whole

maxLength? ​

number

Returns ​

string

Released under the MIT License.