...
To preview Hyperledger Besu documentation locally:
- Install Python 3
- Have PIP3 installed alongside Python 3.
- Install all the required dependencies :
pip3python3 -m pip install -r docs/requirements.txt
- Run the following command in the project directory :
mkdocs serve
- Follow the link displayed on the output of this command that looks like
[I 190206 18:48:47 server:298] Serving on http://127.0.0.1:8000
, here connect to [http://127.0.0.1:8000]
You can let this doc server run while you work on the doc, it updates the local website automatically when you save changes in your Markdown files.
Important: Run To check that mkdocs
is using the correct python version, run head $(which mkdocs)
to get the path to the python executable, then /path/to/python --version
to make sure you are using version indicated which should match what is specified in readthedocs.yml
file. If you are updating from a previous Python version you will also have to run pip3 install again and check your path. in the project directory
Formatting Markdown For Doc Site
...