# docusaurus2-dotenv

> A Docusaurus2 plugin that supports dotenv and other environment variables and only exposes what you choose and use

Latest version **1.4.0** (published 2020-05-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install docusaurus2-dotenv
pnpm add docusaurus2-dotenv
yarn add docusaurus2-dotenv
bun add docusaurus2-dotenv
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2020-05-08 |
| First published | 2020-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | Jonny Nabors |
| Maintainers | jonathannabors |
| Keywords | docusaurus, docusaurus2, dotenv, webpack, env |

## Links

- npm: https://www.npmjs.com/package/docusaurus2-dotenv
- Repository: https://github.com/jonnynabors/docusaurus2-dotenv
- Homepage: https://github.com/jonnynabors/docusaurus2-dotenv#readme
- Issues: https://github.com/jonnynabors/docusaurus2-dotenv/issues
- npm.io page: https://npm.io/package/docusaurus2-dotenv

## Dependencies (1)

- [dotenv-webpack](https://npm.io/package/dotenv-webpack.md) 1.7.0

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 1.4.0 (latest) — 2020-05-08
- 1.3.0 — 2020-05-08
- 1.2.0 — 2020-05-08
- 1.1.0 — 2020-05-08
- 1.0.0 — 2020-05-08

## README

A Docusaurus2 plugin that supports dotenv and other environment variables and only exposes what you choose and use

### Installation

Install the package in your repository

`npm install docusaurus2-dotenv`

or

`yarn add docusaurus2-dotenv`

### Description

The `docusaurus2-dotenv` plugin wraps the `dotenv-webpack` library to allow the usage of `.env` files in Docusaurus2 projects. This allows you to access your environment variables via `process.env.VARIABLE_NAME` in your code.

### Usage

The plugin can be used "out of the box" using the standard configuration. In your `docusaurus.config.js` file, add the following to your `plugins` block.

```javascript
docusaurus.config.js

module.exports = {
    ..., // other Docusaurus2 settings
    plugins: [
        'docusaurus2-dotenv'
    ],
    ... // other Docusaurus2 settings
}
```

### Properties

Use the following properties to configure your instance.

- **path** (`'./.env'`) - The path to your environment variables.
- **safe** (`false`) - If true, load '.env.example' to verify the '.env' variables are all set. Can also be a string to a different file.
- **systemvars** (`false`) - Set to true if you would rather load all system variables as well (useful for CI purposes).
- **silent** (`false`) - If true, all warnings will be suppressed.
- **expand** (`false`) - Allows your variables to be "expanded" for reusability within your `.env` file.
- **defaults** (`false`) - Adds support for `dotenv-defaults`. If set to `true`, uses `./.env.defaults`. If a string, uses that location for a defaults file.

```javascript
docusaurus.config.js

module.exports = {
    ..., // other Docusaurus2 settings
    plugins: [
        [
            'docusaurus2-dotenv',
            {
                path: "./.env", // The path to your environment variables.
                safe: false, // If false ignore safe-mode, if true load './.env.example', if a string load that file as the sample
                systemvars: false, // Set to true if you would rather load all system variables as well (useful for CI purposes)
                silent: false, //  If true, all warnings will be suppressed
                expand: false, // Allows your variables to be "expanded" for reusability within your .env file
                defaults: false, //  Adds support for dotenv-defaults. If set to true, uses ./.env.defaults
            }
        ]
    ],
    ... // other Docusaurus2 settings
}
```

#### Recommended

Add `.env` to your `.gitignore` file

---
_Source: https://npm.io/package/docusaurus2-dotenv · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._