arbitrum-docs

(β˜… 251)

Arbitrum Docs! Content + Webapp

  • .env.example
  • .gitignore
  • .markdownlint.json
  • .node-version
  • .prettierignore
  • .prettierrc.js
  • AGENTS.md
  • babel.config.js
  • CLAUDE.md
  • CONTRIBUTE.md
  • dependencies.json
  • docusaurus.config.js
  • inkeep.config.js
  • inkeep.js
  • middleware.ts
  • package.json
  • README.md
  • redirects.config.d.ts
  • redirects.config.js
  • sdk-sidebar.js
  • sidebars.d.ts
  • sidebars.js
  • svgo.config.mjs
  • tsconfig.json
  • vercel.json
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/OffchainLabs/arbitrum-docs

Downloads the entire project code from GitHub to your computer.

cd arbitrum-docs

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
yarn

Downloads and installs the libraries listed in package.json.

yarn build

Builds optimized production files.

yarn start

Starts the development/run server.

yarn serve

Type this command into your terminal and run it.

yarn generate-cli-reference

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation