@telus-uds/docusaurus-plugin-webpack-config

Docusaurus plugin webpack config

Plugin designed to integrate webpack configurations into UDS Docusaurus project. It simplifies the management of webpack settings, allowing to optimize and tailor the docusaurus build to specific needs. It uses dotenv-webpack to enable Dotenv support and allows you to access your environment variables via process.env.VARIABLE_NAME. It also helps dynamically define environment variables within the webpack build and setup dependency fallbacks ensuring compatibility by resolving common dependencies with fallbacks.

Plugin Configuration Options:

• context: The context object provided by Docusaurus.

• options: Configuration options for the plugin.

• fallback: Fallbacks for resolving dependencies in webpack's resolve section.

• constants: Constants to be defined using webpack's DefinePlugin.

• dotenv: Options for configuring dotenv-webpack (e.g., path to .env file).

  • path: The path to your environment variables.

  • safe: If true, load '.env.example' to verify '.env' variables. Can be a string for a different file.

  • allowEmptyValues: Whether to allow empty strings in safe mode. Throws an error if any env variables are empty in safe mode.

  • systemvars: Load all system variables as well (useful for CI purposes).

  • silent: Suppress all warnings.

  • expand: Allows your variables to be "expanded" for reusability within your .env file.

  • defaults: Adds support for dotenv-defaults. If an object, uses specified properties as defaults. If a string, uses that location for a defaults file.

  • ignoreStub: Override the automatic check whether to stub process.env.

  • prefix: The prefix to use before the name of your env variables.

Setup

1. Install this plugin into a UDS docusaurus docs site

   npm install --save @telus-uds/docusaurus-plugin-webpack-config

2. Add the plugin to the docusaurus.config.js

   module.exports = {
     // ...
   
     plugins: ['@telus-uds/docusaurus-plugin-webpack-config']
   
     // ...
   }