{"id":18160780,"url":"https://github.com/hyoban/remark-github-alerts","last_synced_at":"2025-05-07T08:45:39.654Z","repository":{"id":210195972,"uuid":"725957850","full_name":"hyoban/remark-github-alerts","owner":"hyoban","description":"Support GitHub-style alerts for remark","archived":false,"fork":false,"pushed_at":"2025-03-21T02:09:25.000Z","size":761,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-26T23:02:37.651Z","etag":null,"topics":["github-flavored-markdown","markdown","nextra","remark"],"latest_commit_sha":null,"homepage":"https://remark-github-alerts.vercel.app","language":"HTML","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/hyoban.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-01T08:22:55.000Z","updated_at":"2025-03-23T08:26:05.000Z","dependencies_parsed_at":"2024-03-10T12:29:14.473Z","dependency_job_id":"a1f2c8a6-dc43-426d-aab9-5f42c5208edb","html_url":"https://github.com/hyoban/remark-github-alerts","commit_stats":null,"previous_names":["hyoban/remark-github-alerts"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyoban%2Fremark-github-alerts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyoban%2Fremark-github-alerts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyoban%2Fremark-github-alerts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyoban%2Fremark-github-alerts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyoban","download_url":"https://codeload.github.com/hyoban/remark-github-alerts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252846453,"owners_count":21813425,"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":["github-flavored-markdown","markdown","nextra","remark"],"created_at":"2024-11-02T08:09:19.634Z","updated_at":"2025-05-07T08:45:39.634Z","avatar_url":"https://github.com/hyoban.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# remark-github-alerts\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![bundle][bundle-src]][bundle-href]\n[![JSDocs][jsdocs-src]][jsdocs-href]\n[![License][license-src]][license-href]\n\n1. Ported from [antfu/markdown-it-github-alerts](https://github.com/antfu/markdown-it-github-alerts)\n1. Support GitHub-style alerts for remark\n1. Check out the [demo](https://remark-github-alerts.vercel.app)\n\n## Usage\n\nInstall the package:\n\n```sh\nni remark-github-alerts\n```\n\nAdd the plugin to your `processor`:\n\n```ts\nimport remarkGithubAlerts from \"remark-github-alerts\";\n\nconst processor = unified()\n  .use(remarkParse)\n  .use(remarkGithubAlerts)\n  .use(remarkRehype)\n  .use(rehypeStringify);\n```\n\nImport the styles:\n\n```ts\nimport \"remark-github-alerts/styles/github-colors-light.css\";\nimport \"remark-github-alerts/styles/github-colors-dark-class.css\";\n// or\n// import \"remark-github-alerts/styles/github-colors-dark-media.css\"\nimport \"remark-github-alerts/styles/github-base.css\";\n```\n\nIf you are using Nextra, you can add the plugin to your `next.config.mjs`:\n\n```ts\nimport nextra from \"nextra\";\nimport remarkGithubAlerts from \"remark-github-alerts\";\n\nconst withNextra = nextra({\n  theme: \"nextra-theme-docs\",\n  themeConfig: \"./theme.config.tsx\",\n  mdxOptions: {\n    remarkPlugins: [remarkGithubAlerts],\n  },\n});\n\nexport default withNextra();\n```\n\n## Check Also\n\n- [GitHub-style alerts](https://github.com/orgs/community/discussions/16925)\n- [markdown-it-github-alerts](https://github.com/antfu/markdown-it-github-alerts)\n- [vscode-markdown-alert](https://github.com/KeJunMao/vscode-markdown-alert)\n- [remark-github-alerts](https://github.com/qhanw/remark-gh-alerts)\n\n\u003c!-- Badges --\u003e\n\n[npm-version-src]: https://img.shields.io/npm/v/remark-github-alerts?style=flat\u0026colorA=080f12\u0026colorB=1fa669\n[npm-version-href]: https://npmjs.com/package/remark-github-alerts\n[npm-downloads-src]: https://img.shields.io/npm/dm/remark-github-alerts?style=flat\u0026colorA=080f12\u0026colorB=1fa669\n[npm-downloads-href]: https://npmjs.com/package/remark-github-alerts\n[bundle-src]: https://img.shields.io/bundlephobia/minzip/remark-github-alerts?style=flat\u0026colorA=080f12\u0026colorB=1fa669\u0026label=minzip\n[bundle-href]: https://bundlephobia.com/result?p=remark-github-alerts\n[license-src]: https://img.shields.io/github/license/hyoban/remark-github-alerts.svg?style=flat\u0026colorA=080f12\u0026colorB=1fa669\n[license-href]: https://github.com/hyoban/remark-github-alerts/blob/main/LICENSE\n[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat\u0026colorA=080f12\u0026colorB=1fa669\n[jsdocs-href]: https://www.jsdocs.io/package/remark-github-alerts\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyoban%2Fremark-github-alerts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyoban%2Fremark-github-alerts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyoban%2Fremark-github-alerts/lists"}