Skip to content

akramaglan20/arbitrum-docs

 
 

Repository files navigation

Arbitrum Docs

Arbitrum Docs, built with docusaurus; docs are live at https://developer.arbitrum.io/.

Arbitrum SDK auto-genned docs are included as submodule.

Contribution

For most of the docs content, you can contribute by simply reviewing our docs contribution guidelines and opening a PR!

The following are the only exceptions:

Initial set up

git clone [email protected]:OffchainLabs/arbitrum-docs.git

cd arbitrum-docs/

git submodule update --init --recursive

cd website/

Install node dependencies

yarn

You will only need to generate docs once:

yarn generate_sdk_docs

Dev Build

Live build without generating sdk docs (recommended):

yarn start_nitro_docs 

(Re)generate sdk docs and live build:

yarn start

Update submodules

Sdk repo:

git submodule update --remote arbitrum-sdk

About

Arbitrum Docs! Content + Webapp

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • MDX 75.2%
  • JavaScript 12.8%
  • TypeScript 5.8%
  • CSS 3.3%
  • SCSS 2.5%
  • Less 0.4%