https://github.com/hyperledger-web3j/web3j-docs
Web3j documentation repository.
https://github.com/hyperledger-web3j/web3j-docs
Last synced: 11 months ago
JSON representation
Web3j documentation repository.
- Host: GitHub
- URL: https://github.com/hyperledger-web3j/web3j-docs
- Owner: hyperledger-web3j
- License: other
- Created: 2019-10-17T12:06:34.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T07:58:25.000Z (11 months ago)
- Last Synced: 2025-02-14T08:34:10.505Z (11 months ago)
- Homepage:
- Size: 16.8 MB
- Stars: 34
- Watchers: 11
- Forks: 21
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# web3j-docs
Web3j Documentation repository.
[docs.web3j.io](http://docs.web3j.io)
## Project setup
Make sure you have [Pipenv](https://docs.pipenv.org/en/latest/) installed.
Then run the following to get up and running:
```bash
git clone https://github.com/web3j/web3j-docs.git
cd web3j-docs
pipenv install
```
## Build instructions
Install mkdocs material theme:
```bash
pip install mkdocs-material
```
Install [mike](https://github.com/jimporter/mike)
```bash
pip install mike
```
Run locally using:
```bash
mike serve
```
To build and push to web3j-docs:
```bash
mike deploy VERSION ALIAS -p
```
Set default version to latest
```bash
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