{"id":27911246,"url":"https://github.com/aliezzahn/rsbuild-plugin-markdown-loader","last_synced_at":"2025-12-27T03:35:46.833Z","repository":{"id":291315930,"uuid":"977252611","full_name":"aliezzahn/rsbuild-plugin-markdown-loader","owner":"aliezzahn","description":"A plugin for rsbuild.dev that enables importing and rendering Markdown files as React components or pure HTML.","archived":false,"fork":false,"pushed_at":"2025-05-04T08:28:19.000Z","size":27,"stargazers_count":11,"open_issues_count":0,"forks_count":11,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-11T02:46:52.077Z","etag":null,"topics":["html","lib","loader","markdown","neon","parser","plugin","react","rsbuild","rspack","rust"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/rsbuild-plugin-markdown-loader","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/aliezzahn.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-03T19:11:52.000Z","updated_at":"2025-05-04T08:28:23.000Z","dependencies_parsed_at":"2025-05-03T20:39:38.874Z","dependency_job_id":null,"html_url":"https://github.com/aliezzahn/rsbuild-plugin-markdown-loader","commit_stats":null,"previous_names":["aliezzahn/rsbuild-plugin-markdown-loader"],"tags_count":0,"template":false,"template_full_name":"rspack-contrib/rsbuild-plugin-template","purl":"pkg:github/aliezzahn/rsbuild-plugin-markdown-loader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aliezzahn%2Frsbuild-plugin-markdown-loader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aliezzahn%2Frsbuild-plugin-markdown-loader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aliezzahn%2Frsbuild-plugin-markdown-loader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aliezzahn%2Frsbuild-plugin-markdown-loader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aliezzahn","download_url":"https://codeload.github.com/aliezzahn/rsbuild-plugin-markdown-loader/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aliezzahn%2Frsbuild-plugin-markdown-loader/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28071442,"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","status":"online","status_checked_at":"2025-12-27T02:00:05.897Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["html","lib","loader","markdown","neon","parser","plugin","react","rsbuild","rspack","rust"],"created_at":"2025-05-06T10:02:05.773Z","updated_at":"2025-12-27T03:35:46.828Z","avatar_url":"https://github.com/aliezzahn.png","language":"TypeScript","readme":"[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/web-infra-dev/awesome-rspack)\n\n# rsbuild-plugin-markdown-loader\n\nA custom Markdown loader plugin for [Rsbuild](https://rsbuild.dev) that supports transforming `.md` files using a high-performance [Neon](https://neon-bindings.com/) Rust parser. Supports GitHub-flavored Markdown (GFM).\n\n\u003cp\u003e\n  \u003ca href=\"https://npmjs.com/package/rsbuild-plugin-markdown-loader\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/rsbuild-plugin-markdown-loader?style=flat-square\u0026colorA=564341\u0026colorB=EDED91\" alt=\"npm version\" /\u003e\n  \u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square\u0026colorA=564341\u0026colorB=EDED91\" alt=\"license\" /\u003e\n  \u003ca href=\"https://npmcharts.com/compare/rsbuild-plugin-markdown-loader?minimal=true\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/rsbuild-plugin-markdown-loader.svg?style=flat-square\u0026colorA=564341\u0026colorB=EDED91\" alt=\"downloads\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n- Parses `.md` files via a fast Rust backend using Neon\n- Optional GitHub-flavored Markdown support\n- Easily pluggable into any Rsbuild project\n\n---\n\n## Installation\n\n```bash\nnpm add rsbuild-plugin-markdown-loader -D\n```\n```bash\nbun add -d rsbuild-plugin-markdown-loader \n```\n\n\u003e **Note:** You must also install the `rs-markdown-parser` native module, which is a Neon-powered Markdown parser.\n\n```bash\nnpm add rs-markdown-parser\n```\n```bash\nbun  add rs-markdown-parser\n```\n\n---\n\n## Usage\n\nAdd the plugin to your `rsbuild.config.ts`:\n\n```ts\n// rsbuild.config.ts\nimport { pluginMarkdownLoader } from \"rsbuild-plugin-markdown-loader\";\n\nexport default {\n  plugins: [\n    pluginMarkdownLoader({\n      gfm: true,\n    }),\n  ],\n};\n```\n\n---\n\n## Use Case\n\nWhen this plugin is configured, you can directly import `.md` files into your frontend code and render them as HTML.\n\n### Example: Markdown as Component Content\n\n```ts\n// main.ts or playground.ts\nimport \"./index.css\";\nimport Test from \"./test.md\";\n\ndocument.querySelector(\"#root\").innerHTML = `\n  \u003cdiv class=\"content\"\u003e\n    ${Test}\n  \u003c/div\u003e\n`;\n```\n\n### Example: `test.md`\n\n```md\n# Hello Markdown 👋\n\nThis is a **Markdown** file rendered using a custom Rsbuild plugin!\n\n- Fast parsing via Rust (Neon)\n- Supports GitHub-flavored markdown (optional)\n```\n\n### Example: `index.css`\n\n```css\n.content {\n  max-width: 600px;\n  margin: 2rem auto;\n  font-family: system-ui, sans-serif;\n  line-height: 1.6;\n}\n```\n\nWhen you build or serve this project using `rsbuild`, the plugin will automatically transform `test.md` into a JavaScript string containing the rendered HTML, which is then injected into the page.\n\n## Options\n\n### `gfm`\n\nEnable GitHub-flavored Markdown extensions.\n\n- **Type**: `boolean`\n- **Default**: `false`\n\n#### Example:\n\n```ts\npluginMarkdownLoader({\n  gfm: true,\n});\n```\n\n---\n\n## How It Works\n\nThis plugin hooks into Rsbuild's Rspack config to apply a custom loader (`markdown-loader.cjs`) for `.md` files. The loader internally calls a Neon-powered Rust function for fast parsing.\n\n```js\n{\n  test: /\\.md$/,\n  use: [\n    {\n      loader: './markdown-loader.cjs',\n      options: {\n        gfm: true,\n      },\n    },\n  ],\n  type: 'javascript/auto',\n}\n```\n\n---\n\n## Loader Implementation\n\n```js\n// Loader wrapper for the Neon module\nconst { processMarkdown } = require(\"rs-markdown-parser\");\n\nmodule.exports = function (content, map, meta) {\n  const callback = this.async();\n  const options = this.getOptions();\n  const filePath = this.resourcePath;\n\n  try {\n    // Call the Rust function via Neon\n    const result = processMarkdown(filePath, options.gfm || false);\n    callback(null, result, map, meta);\n  } catch (err) {\n    callback(err);\n  }\n};\n```\n\n---\n\n## License\n\n[MIT](./LICENSE)\n","funding_links":[],"categories":["Plugins"],"sub_categories":["Rspack Loaders"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faliezzahn%2Frsbuild-plugin-markdown-loader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faliezzahn%2Frsbuild-plugin-markdown-loader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faliezzahn%2Frsbuild-plugin-markdown-loader/lists"}