Skip to content

MetaMask project documentation

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

ronielex/metamask-docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

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. Initialize and update the keyring-api submodule.

    git submodule init && git submodule update
  3. Install dependencies.

    yarn install
  4. 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.

About

MetaMask project documentation

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 49.3%
  • TypeScript 20.9%
  • CSS 16.0%
  • MDX 13.8%