@md-plugins/md-plugin-title 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,85 @@
+# @md-plugins/md-plugin-title
+
+A **Markdown-It** plugin that extracts the first `<h1>` title from Markdown content and stores it in the Markdown-It environment (`env`). This is particularly useful for generating page titles dynamically or for metadata extraction in documentation and content management systems.
+
+## Features
+
+- Extracts the first `<h1>` from Markdown content.
+- Stores the extracted title in the `title` property of the Markdown-It environment (`env`).
+- Provides flexibility to handle scenarios with or without a title.
+- Seamlessly integrates into content pipelines for title-based features.
+
+## Installation
+
+Install the plugin via your preferred package manager:
+
+```bash
+# With npm:
+npm install @md-plugins/md-plugin-title
+# Or with Yarn:
+yarn add @md-plugins/md-plugin-title
+# Or with pnpm:
+pnpm add @md-plugins/md-plugin-title
+```
+
+## Usage
+
+### Basic Setup
+
+```js
+import MarkdownIt from 'markdown-it';
+import { titlePlugin } from '@md-plugins/md-plugin-title';
+import type { MarkdownItEnv } from '@md-plugins/shared';
+
+const md = new MarkdownIt();
+md.use(titlePlugin);
+
+const markdownContent = `
+# This is the Page Title
+
+Some content here.
+`;
+
+const env: MarkdownItEnv = {};
+const renderedOutput = md.render(markdownContent, env);
+
+console.log('Rendered Output:', renderedOutput);
+console.log('Extracted Title:', env.title);
+```
+
+### Example Output
+
+For the example above, the `env` will contain the following:
+
+```json
+{
+  "title": "This is the Page Title"
+}
+```
+
+And the rendered Markdown output will appear as usual:
+
+```html
+<h1>This is the Page Title</h1>
+<p>Some content here.</p>
+```
+
+## Options
+
+The `md-plugin-title` plugin does not currently accept configuration options. It automatically extracts the first `<h1>` element.
+
+## Note
+
+This plugin is not needed is using the `@md-plugins/md-plugin-frontmatter` plugin.
+
+## Testing
+
+Run the tests to ensure the plugin behaves as expected:
+
+```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,20 @@
+import { PluginSimple } from 'markdown-it';
+
+/**
+ * Get markdown page title info
+ *
+ * Extract it into env
+ */
+declare const titlePlugin: PluginSimple;
+
+declare module '@md-plugins/shared' {
+    interface MarkdownItEnv {
+        /**
+         * The title that extracted by `md-plugin-title`
+         */
+        title?: string;
+        heading?: boolean;
+    }
+}
+
+export { titlePlugin };

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { PluginSimple } from 'markdown-it';
+
+/**
+ * Get markdown page title info
+ *
+ * Extract it into env
+ */
+declare const titlePlugin: PluginSimple;
+
+declare module '@md-plugins/shared' {
+    interface MarkdownItEnv {
+        /**
+         * The title that extracted by `md-plugin-title`
+         */
+        title?: string;
+        heading?: boolean;
+    }
+}
+
+export { titlePlugin };

package/dist/index.mjs

@@ -0,0 +1,16 @@
+import { resolveTitleFromToken } from '@md-plugins/shared';
+
+const titlePlugin = (md) => {
+  const render = md.renderer.render.bind(md.renderer);
+  md.renderer.render = (tokens, options, env) => {
+    const tokenIdx = tokens.findIndex((token) => token.tag === "h1");
+    env.title = tokenIdx > -1 ? resolveTitleFromToken(tokens[tokenIdx + 1], {
+      shouldAllowHtml: false,
+      shouldEscapeText: false
+    }) : "";
+    env.heading = !!env.title;
+    return render(tokens, options, env);
+  };
+};
+
+export { titlePlugin };

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@md-plugins/md-plugin-title",
+  "version": "0.1.0-alpha.1",
+  "description": "A markdown-it plugin for getting Title information.",
+  "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"
+  }
+}