...

To preview Hyperledger Besu documentation locally:

• Install Python 3
• Create a virtual environment for the project running:

  python3 -m venv env

  this will add an env dir in your project. Never commit it, it should be ignored by git but if not, ignore it and commit the changes in the .gitignore file.
• Activate the virtual environment: source env/bin/activate
  Notice the (env) at the beginning of your prompt now, you activated the virtual environment.
• Install all the required dependencies :python3 -m pip install -r docsdependencies in this virtual environment: pip install -r CI/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.

Note: Deactivate the virtual environment if you work on another Python project. To do so, run: deactivate
See Python 3 virtual environment doc for more details.  

Important: 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  version  which should match what is specified in readthedocs.yml  yml  in the project directory

Formatting Markdown For Doc Site

...