README.md

Neutrino HTML Loader Middleware

@neutrinojs/html-loader is Neutrino middleware for loading and importing HTML files from modules.

Requirements

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

Installation

@neutrinojs/html-loader can be installed via the Yarn or npm clients.

Yarn

❯ yarn add @neutrinojs/html-loader

npm

❯ npm install --save @neutrinojs/html-loader

Usage

@neutrinojs/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('@neutrinojs/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: ['@neutrinojs/html-loader']
};

// Usage showing default options
module.exports = {
  use: [
    ['@neutrinojs/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

@neutrinojs/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 and Commands
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.