Updating this guide
We use Material for MkDocs to produce our documentation.
Before You Start
- Clone the repository by
git clone https://github.com/status-im/nimbus-eth2.git.
- Go to the
docsfolder and type
- Activate mkdocs:
- Go to where the Markdown files are located by
Real-Time Update and Preview Changes
mkdocs servein the terminal.
- Preview the book at http://localhost:8000.
Build and Deploy
The first step is to submit a pull request to the unstable branch. Then, after it is merged, do the following under our main repository:
If you see file conflicts in the pull request, this may due to that you have created your new branch from an old version of the
unstable branch. Update your new branch using the following commands:
Thank you so much for your help to the decentralized and open source community. :)