Neutrino HTML Loader Middleware

NPM version NPM downloads Join Slack

neutrino-middleware-html-loader is Neutrino middleware for loading and importing HTML files from modules.

Requirements

  • Node.js v6.10+
  • Yarn or npm client
  • Neutrino v6

Installation

neutrino-middleware-html-loader can be installed via the Yarn or npm clients.

Yarn

❯ yarn add neutrino-middleware-html-loader

npm

npm install --save neutrino-middleware-html-loader

Usage

neutrino-middleware-html-loader can be consumed from the Neutrino API, middleware, or presets. Require this package and plug it into Neutrino:

// Using function middleware format
const html = require('neutrino-middleware-html-loader');

// Use with default options
neutrino.use(html);

// Usage showing default options
neutrino.use(html, {
  name: '[name].[ext]'
});
// Using object or array middleware format

// Use with default options
module.exports = {
  use: ['neutrino-middleware-html-loader']
};

// Usage showing default options
module.exports = {
  use: [
    ['neutrino-middleware-html-loader', {
      name: '[name].[ext]'
    }]
  ]
};

The options object passed to this middleware will be passed as options to the html-loader used to load HTML files.

Customization

neutrino-middleware-html-loader creates some conventions to make overriding the configuration easier once you are ready to make changes.

Rules

The following is a list of rules and their identifiers which can be overridden:

Name Description Environments
html Allows importing HTML files from modules. Contains a single loader named html. all

Contributing

This middleware is part of the neutrino-dev repository, a monorepo containing all resources for developing Neutrino and its core presets and middleware. Follow the contributing guide for details.

results matching ""

    No results matching ""