Batch render markdowns via GitHub-API

For batch-rendering an array of Markdown strings via GitHub's API (using Octokit/REST).

Uses only 1 GitHub-API request to render all the markdown strings.

Useful for mitigating GitHub's API's request rate-limit.

Install

npm i github-markdown-batch-render

Usage

Basic usage:

constmarkdowns=['**bold** _italic_','# Title\n\nParagrapgh','```\nCodeblock\n```']constrenderedMarkdowns=awaitghMdBatchRender(markdowns)/** * 'renderedMarkdowns' will be: [ * '<p><strong>bold</strong> <em>italic</em></p>', * '<h1>Title</h1>\n<p>Paragrapgh</p>', * '<pre class="notranslate"><code class="notranslate">Codeblock\n</code></pre>' * ] */

Force use an Octokit instance:

constoctokit=newOctokit({auth: 'personalaccesstoken'})constrenderedMarkdowns=awaitghMdBatchRender(markdowns,{ octokit })

Passing mode / context option(s) to the Octokit.rest.markdown.render method:

Note: ghMdBatchRender's mode option defaults to "gfm" unlike Octokit, which defaults to "markdown".

constrenderedMarkdowns=awaitghMdBatchRender(markdowns,{mode: 'markdown',// default is "gfm"context: 'github/linguist',})