andreiralko / web3j-docs

Web3j documentation repository.

web3j-docs

Web3j Documentation repository.

docs.web3j.io

To modify the documentation simply submit a pull request agains the master branch.

Once the pull request has been merged the website will reflect the changes.

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

Run locally using:

mkdocs serve

To build and push to web3j-docs:

mkdocs gh-deploy