{"id":23193957,"url":"https://github.com/evitanrelta/github-markdown-batch-render","last_synced_at":"2026-04-10T23:03:56.870Z","repository":{"id":61838991,"uuid":"553611771","full_name":"EvitanRelta/github-markdown-batch-render","owner":"EvitanRelta","description":"To batch-render Markdown strings via GitHub's API (using Octokit/REST). For mitigating GitHub's API's request rate-limit.","archived":false,"fork":false,"pushed_at":"2022-10-19T10:24:12.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-14T00:03:12.929Z","etag":null,"topics":["batch-processing","batch-rendering","gfm","github-api","github-flavored-markdown","github-markdown","markdown","markdown-renderer","octokit"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/github-markdown-batch-render","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EvitanRelta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-10-18T13:37:05.000Z","updated_at":"2022-10-18T16:10:38.000Z","dependencies_parsed_at":"2022-10-22T05:00:39.177Z","dependency_job_id":null,"html_url":"https://github.com/EvitanRelta/github-markdown-batch-render","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EvitanRelta%2Fgithub-markdown-batch-render","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EvitanRelta%2Fgithub-markdown-batch-render/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EvitanRelta%2Fgithub-markdown-batch-render/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EvitanRelta%2Fgithub-markdown-batch-render/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EvitanRelta","download_url":"https://codeload.github.com/EvitanRelta/github-markdown-batch-render/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305898,"owners_count":20917202,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["batch-processing","batch-rendering","gfm","github-api","github-flavored-markdown","github-markdown","markdown","markdown-renderer","octokit"],"created_at":"2024-12-18T13:12:54.798Z","updated_at":"2026-04-10T23:03:56.834Z","avatar_url":"https://github.com/EvitanRelta.png","language":"TypeScript","readme":"# Batch render markdowns via GitHub-API\n\nFor batch-rendering an array of Markdown strings via GitHub's API *(using Octokit/REST)*.\n\nUses only 1 GitHub-API request to render all the markdown strings.\n\n\u003e Useful for mitigating GitHub's API's request rate-limit.\n\n\u003cbr\u003e\n\n## Install\n\n```bash\nnpm i github-markdown-batch-render\n```\n\n\u003cbr\u003e\n\n## Usage\n\nBasic usage:\n\n````typescript\nconst markdowns = [\n    '**bold** _italic_', \n    '# Title\\n\\nParagrapgh', \n    '```\\nCodeblock\\n```'\n]\nconst renderedMarkdowns = await ghMdBatchRender(markdowns)\n/**\n * 'renderedMarkdowns' will be: [\n *     '\u003cp\u003e\u003cstrong\u003ebold\u003c/strong\u003e \u003cem\u003eitalic\u003c/em\u003e\u003c/p\u003e',\n *     '\u003ch1\u003eTitle\u003c/h1\u003e\\n\u003cp\u003eParagrapgh\u003c/p\u003e',\n *     '\u003cpre class=\"notranslate\"\u003e\u003ccode class=\"notranslate\"\u003eCodeblock\\n\u003c/code\u003e\u003c/pre\u003e'\n * ]\n */\n````\n\n\u003cbr\u003eForce use an `Octokit` instance:\n\n```typescript\nconst octokit = new Octokit({ auth: 'personalaccesstoken' })\nconst renderedMarkdowns = await ghMdBatchRender(markdowns, { octokit })\n```\n\n\u003cbr\u003ePassing `mode` / `context` option(s) to the [`Octokit.rest.markdown.render`](https://octokit.github.io/rest.js/v19#markdown-render) method:\n\n\u003e Note: `ghMdBatchRender`'s `mode` option defaults to `\"gfm\"` unlike Octokit, which defaults to `\"markdown\"`.\n\n```typescript\nconst renderedMarkdowns = await ghMdBatchRender(markdowns, {\n    mode: 'markdown', // default is \"gfm\"\n    context: 'github/linguist',\n})\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevitanrelta%2Fgithub-markdown-batch-render","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevitanrelta%2Fgithub-markdown-batch-render","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevitanrelta%2Fgithub-markdown-batch-render/lists"}