vite-markdown-injector v1.2.5

Vite Markdown Injector 🚩 Currently not working 🚩

Vite Markdown Injector is a powerful npm package that allows you to seamlessly inject markdown content into your Vite-powered projects. With just a few lines of code, you can enhance your web applications with dynamic and interactive markdown content.

Features

• Easy integration with Vite projects
• Markdown content injection on the fly
• Customizable rendering options
• Support for front matter and metadata
• Syntax highlighting for code blocks
• Live preview and hot module replacement

Installation

To install Vite Markdown Injector, simply run the following command:

npm install vite-markdown-injector

Usage

1. Import the injectMarkdown function in your vite config:

import { injectMarkdown } from "vite-markdown-injector";

export default defineConfig({
  plugins: [
    injectMarkdown({
      tag: "markdown", // default tag for injection in html is <md src="..." />
      hmr: true, // hot module replacement (boolean, set to true by default),
    }),
  ],
  // ...
});

2. Use the <md /> tag (or the one you specified in the vite config) to inject markdown content into your HTML

3. Add a src="..." attribute whichs path points to the path of your markdown file.

Now the following:
<h1>
  <md src="src/content/header.md" />
</h1>

becomes:
<h1>Headline from my markdown file 🤓</h1>

3. Enjoy the dynamic markdown content in your Vite-powered application! For more detailed usage instructions and examples, please refer to the documentation. ## Contributing Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request on the GitHub repository. ## License This project is licensed under the MIT License.