1.0.0 • Published 5 years ago

gatsby-plugin-easter-egg v1.0.0

Weekly downloads
5
License
-
Repository
-
Last release
5 years ago

gatsby-plugin-easter-egg

A Gatsby plugin that easily adds a hidden key combination which reveals hidden functionality

Installation

Install with npm:

npm install --save gatsby-plugin-easter-egg

Install with yarn:

yarn add gatsby-plugin-easter-egg

Configuration

After installing gatsby-plugin-easter-egg, add it to gatsby-config.js:

module.exports = {
  plugins: [
    // ...
    `gatsby-plugin-easter-egg`
  ]
};

Options

gatsby-plugin-easter-egg exposes a few options which can be used to customize and test the plugin.

OptionDefaultDescription
sequenceup up down down left right left right b a enterDefaults to the Konami Code, can be set to anything. See documentation for more key capture information
debugfalseDisplays console debug information, and exposes the secret function on the Window
module.exports = {
  plugins: [
    // ...
    {
      resolve: `gatsby-plugin-easter-egg`,
      options: {
        sequence: `a s d f`,
        debug: true
      }
    }
  ]
};

License

MIT