⚠️ Temporary pause on contributions to the MetaMask docs repository

Starting August 3, 2024, contributions to this repository will be temporarily paused. Pull requests submitted during this period will not be reviewed or merged until after the pause. Thank you for your understanding.

MetaMask developer documentation

This is the MetaMask developer documentation repository. The documentation site is hosted at docs.metamask.io, and it's built using Docusaurus, a static site generator purpose-built for technical documentation.

Build locally

Build the documentation site locally using the following steps.

Prerequisites

• Node.js version 18+
• Yarn version 3
• Git

Steps

1. Clone the repository.

   git clone https://github.com/MetaMask/metamask-docs.git
   cd metamask-docs

   Note: If you don't have write access to this repository, you must fork the repository to your personal account and clone your forked repository instead. Add an upstream remote to be able to pull from and push to the original repository.

   git clone https://github.com/<YOUR-USERNAME>/metamask-docs.git
   cd metamask-docs
   git remote add upstream https://github.com/MetaMask/metamask-docs.git

2. Install dependencies.

   yarn install

3. Start the development server.

   yarn start

   Once the server starts, you can view the documentation at http://localhost:3000.

For more information on contributing to the documentation, see the full contribution guidelines.