@md-plugins/md-plugin-blockquote 0.1.0-alpha.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-present, Jeff Galbraith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# @md-plugins/md-plugin-blockquote
+
+A **Markdown-It** plugin that enhances blockquote rendering by adding customizable CSS classes. This allows for easier styling and alignment with design systems, enabling more visually appealing and consistent blockquote presentation.
+
+## Features
+
+- Adds customizable CSS classes to `<blockquote>` elements.
+- Supports a default class that can be overridden via plugin options.
+
+## Installation
+
+Install the plugin via your preferred package manager:
+
+```bash
+# With npm:
+npm install @md-plugins/md-plugin-blockquote
+# Or with Yarn:
+yarn add @md-plugins/md-plugin-blockquote
+# Or with pnpm:
+pnpm add @md-plugins/md-plugin-blockquote
+```
+
+## Usage
+
+### Basic Setup
+
+```js
+import MarkdownIt from 'markdown-it';
+import { blockquotePlugin } from 'md-plugin-blockquote';
+
+const md = new MarkdownIt();
+md.use(blockquotePlugin, {
+  blockquoteClass: 'custom-blockquote',
+});
+
+const markdownContent = `
+> This is a blockquote.
+`;
+
+const renderedOutput = md.render(markdownContent);
+
+console.log('Rendered Output:', renderedOutput);
+```
+
+### Example Output
+
+The rendered output will include the specified CSS class:
+
+```html
+<blockquote class="custom-blockquote">
+  <p>This is a blockquote.</p>
+</blockquote>
+```
+
+## Options
+
+The `md-plugin-blockquote` plugin supports the following options:
+
+| Option          | Type   | Default               | Description                        |
+| --------------- | ------ | --------------------- | ---------------------------------- |
+| blockquoteClass | string | 'markdown-blockquote' | CSS class to apply to blockquotes. |
+
+## Testing
+
+To run the tests, use the following command:
+
+```bash
+pnpm test
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.

package/dist/index.d.mts

@@ -0,0 +1,14 @@
+import { PluginWithOptions } from 'markdown-it';
+
+interface BlockquotePluginOptions {
+    /**
+     * The class for the blockquote
+     *
+     * @default 'markdown-blockquote'
+     */
+    blockquoteClass?: string;
+}
+
+declare const blockquotePlugin: PluginWithOptions<BlockquotePluginOptions>;
+
+export { type BlockquotePluginOptions, blockquotePlugin };

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { PluginWithOptions } from 'markdown-it';
+
+interface BlockquotePluginOptions {
+    /**
+     * The class for the blockquote
+     *
+     * @default 'markdown-blockquote'
+     */
+    blockquoteClass?: string;
+}
+
+declare const blockquotePlugin: PluginWithOptions<BlockquotePluginOptions>;
+
+export { type BlockquotePluginOptions, blockquotePlugin };

package/dist/index.mjs

@@ -0,0 +1,15 @@
+const blockquotePlugin = (md, { blockquoteClass = "markdown-blockquote" } = {}) => {
+  const originalRender = md.renderer.render.bind(md.renderer);
+  md.renderer.render = (tokens, options, env) => {
+    tokens.forEach((token) => {
+      if (token.tag === "blockquote" && token.type === "blockquote_open") {
+        const existingClass = token.attrGet("class") || "";
+        const newClass = [existingClass, blockquoteClass].filter(Boolean).join(" ");
+        token.attrSet("class", newClass);
+      }
+    });
+    return originalRender(tokens, options, env);
+  };
+};
+
+export { blockquotePlugin };

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@md-plugins/md-plugin-blockquote",
+  "version": "0.1.0-alpha.1",
+  "description": "A markdown-it plugin for Blockquotes with custom styles.",
+  "keywords": [
+    "markdown-it",
+    "quasarframework",
+    "vue",
+    "types"
+  ],
+  "homepage": "https://github.com/md-plugins",
+  "bugs": {
+    "url": "https://github.com/md-plugins/md-plugins/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/md-plugins/md-plugins.git"
+  },
+  "license": "MIT",
+  "author": "hawkeye64 <galbraith64@gmail.com>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
+    }
+  },
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist"
+  ],
+  "dependencies": {
+    "@types/markdown-it": "^14.1.2",
+    "markdown-it": "^14.1.0",
+    "@md-plugins/shared": "0.1.0-alpha.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "clean": "rm -rf dist",
+    "test": "vitest"
+  }
+}