Vite Plugin Readme

Introduction

vite-plugin-readme is a plugin that provides convenient README.md file handling capabilities for Vite projects. It helps developers automatically include the README.md file in the output directory during the build process, or achieve other customized behaviors related to README through configuration.

Installation

Install the plugin using npm or yarn:

npm install vite-plugin-readme --save-dev

or

yarn add -D vite-plugin-readme

Usage

Import the plugin in the Vite configuration file and add it to the plugins list:

import { defineConfig } from 'vite';
import readme from 'vite-plugin-readme';

export default defineConfig({
  plugins: [
    readme()
  ]
});

By default, the plugin will locate the README.md file in the project root directory and copy it to the build output directory. If custom paths or behaviors are required, corresponding configuration parameters can be provided.

Features

• Automatically copies the README.md file to the build output directory.
• Supports configuration of custom paths, flexibly adapting to different project structures.
• Can be extended to handle other types of document files (implemented through configuration).

Contributions

Issues and pull requests are welcome to improve this plugin. Please follow open-source community guidelines, ensure tests pass before submitting code, and provide clear description information.

License

This project is licensed under the MIT License. For details, please refer to the LICENSE file in the project root directory.