isabella232 / web3j-docs

Web3j documentation repository.

web3j-docs

Web3j Documentation repository.

docs.web3j.io

Project setup

Make sure you have Pipenv installed.

Then run the following to get up and running:

git clone https://github.com/web3j/web3j-docs.git
cd web3j-docs
pipenv install

Build instructions

Install mkdocs material theme:

pip install mkdocs-material

Install mike

pip install mike

Run locally using:

mike serve

To build and push to web3j-docs:

mike deploy VERSION ALIAS -p

Set default version to latest

mike set-default VERSION or ALIAS -p

To update the versions of the dependencies simply change them in the mkdocs.yml file under the extra tag