@md-plugins/md-plugin-containers 0.1.0-alpha.1 → 0.1.0-alpha.5

package/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024-present, Jeff Galbraith
+Copyright (c) 2024-present, MD-PLUGINS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -27,16 +27,16 @@ pnpm add @md-plugins/md-plugin-containers
 ### Basic Setup
 
 ```js
-import MarkdownIt from 'markdown-it';
-import { containersPlugin } from '@md-plugins/md-plugin-containers';
+import MarkdownIt from 'markdown-it'
+import { containersPlugin } from '@md-plugins/md-plugin-containers'
 
-const md = new MarkdownIt();
+const md = new MarkdownIt()
 md.use(containersPlugin, {
   containers: [
     { type: 'note', defaultTitle: 'Note' },
     { type: 'warning', defaultTitle: 'Warning' },
   ],
-});
+})
 
 const markdownContent = `
 :::note
@@ -46,11 +46,11 @@ This is a note.
 :::warning
 This is a warning!
 :::
-`;
+`
 
-const renderedOutput = md.render(markdownContent);
+const renderedOutput = md.render(markdownContent)
 
-console.log('Rendered Output:', renderedOutput);
+console.log('Rendered Output:', renderedOutput)
 ```
 
 ### Example Output
@@ -86,7 +86,7 @@ md.use(containersPlugin, {
     { type: 'tip', defaultTitle: 'Tip' },
     { type: 'important', defaultTitle: 'Important' },
   ],
-});
+})
 ```
 
 ## Advanced Usage
@@ -99,24 +99,24 @@ Override the default rendering logic for containers:
 md.use(containersPlugin, {
   containers: [{ type: 'note', defaultTitle: 'Note' }],
   render(tokens, idx) {
-    const token = tokens[idx];
+    const token = tokens[idx]
     if (token.nesting === 1) {
       // Opening tag
-      const title = token.info.trim() || 'Note';
-      return `<div class="custom-note"><strong>${title}:</strong>\n`;
+      const title = token.info.trim() || 'Note'
+      return `<div class="custom-note"><strong>${title}:</strong>\n`
     } else {
       // Closing tag
-      return `</div>\n`;
+      return `</div>\n`
     }
   },
-});
+})
 ```
 
 ## Adding Titles
 
 Containers can include titles by default or allow custom titles to be specified:
 
-```markdown
+```markup
 :::note Custom Note Title
 This is a custom note with a title.
 :::
@@ -135,7 +135,7 @@ Rendered Output:
 
 Containers can be nested if your rendering logic supports it:
 
-```markdown
+```markup
 :::note Outer Note
 :::warning Inner Warning
 Be cautious!

package/dist/index.mjs

@@ -6,9 +6,7 @@ function containersPlugin(md, containers, createContainer) {
     return;
   }
   if (typeof createContainer !== "function") {
-    throw new Error(
-      "Invalid createContainer function provided to containersPlugin."
-    );
+    throw new Error("Invalid createContainer function provided to containersPlugin.");
   }
   containers.forEach(({ type, defaultTitle }) => {
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@md-plugins/md-plugin-containers",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.5",
   "description": "A markdown-it plugin for handling custom containers.",
   "keywords": [
     "markdown-it",
@@ -33,20 +33,24 @@
     "./dist"
   ],
   "dependencies": {
-    "@types/markdown-it": "^14.1.2",
     "markdown-it": "^14.1.0",
     "markdown-it-container": "^4.0.0",
-    "@md-plugins/shared": "0.1.0-alpha.1"
+    "@md-plugins/shared": "0.1.0-alpha.5"
   },
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@types/markdown-it-container": "^2.0.10"
+    "@types/markdown-it-container": "^2.0.10",
+    "@types/markdown-it": "^14.1.2"
+  },
+  "peerDependencies": {
+    "markdown-it": "^14.1.0",
+    "markdown-it-container": "^4.0.0"
   },
   "scripts": {
     "build": "unbuild",
-    "clean": "rm -rf dist",
+    "clean": "rm -rf dist/ node_modules/",
     "test": "vitest"
   }
 }