vite-plugin-inline-source
v4.1.0
Published
A vite plugin for inlining files into HTML
Maintainers
ajbienzReadme
vite-plugin-inline-source
A Vite plugin which inlines source files in HTML files where the inline-source attribute is present. This is similar in premise to vite-plugin-singlefile, but allows you to control which assets are inlined.
This plugin was heavily influenced by markup-inline-loader for webpack. I wanted the same functionality, but couldn't find a suitable replacement in the Vite ecosystem.
Example Usage
Check out the interactive demo on StackBlitz!
vite.config.ts
import { defineConfig } from "vite";
import inlineSource from "vite-plugin-inline-source";
export default defineConfig({
plugins: [
inlineSource(),
],
});style.css
body {
background-color: red;
}index.html
<html>
<style inline-source src="style.css"></style>
</html>Resulting index.html after build
<html>
<style inline-source>body {
background-color: red;
}
</style>
</html>Options
customAttribute
The custom attribute to use for triggering inlining of source files. By default, the plugin uses inline-source. You can set this to a different attribute name if needed.
- type:
string - default:
inline-source
replaceTags
Tags that should be replaced in the HTML file.
For example, style and script tags are not replaced by default because the corresponding css/js file would not contain the style or script tag. However, with svg tags, the corresponding svg file would contain the svg tag, so the svg tags in the HTML file are replaced. See the unit tests for more explicit examples.
- type:
string[] - default:
['svg', 'math']
optimizeSvgs
Whether or not to optimize SVGs using svgo.
- type:
boolean - default:
true
svgoOptions
Options to pass to svgo. Only used if optimizeSvgs is true.
- type:
OptimizeOptions - default:
{}
optimizeCss
Whether or not to optimize CSS using csso.
- type:
boolean - default:
false
cssoOptions
Options to pass to csso. Only used if optimizeCss is true.
- type:
OptimizeOptions - default:
{}
optimizeJs
Whether or not to optimize JS using terser.
- type:
boolean - default:
false
terserOptions
Options to pass to terser. Only used if optimizeJs is true.
- type:
OptimizeOptions - default:
{}
compileSass
Whether or not to compile SASS using sass.
- type:
boolean - default:
false
sassOptions
Options to pass to sass. Only used if compileSass is true.
- type:
OptimizeOptions - default:
{}