Preview the documentation - Besu - LF Decentralized Trust Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window) PreferencesOnly necessaryAccept all LF Decentralized Trust LF Decentralized Trust Spaces Apps Templates Create Besu All content Shortcuts Meetings Meetings  This trigger is hidden How-to articles How-to articles  This trigger is hidden Content Results will update as you type. Code of Conduct Contributing Developing and Conventions Documentation Documentation contribution workflow Documentation contribution guidelines Versioned documentation Documentation archive Documentation release process Documentation style guide Future Release Dates MkDocs and Markdown guide Configure and format Markdown Preview the documentation Extensions Proposal - Besu maintainers become docs maintainers Raise issues Community Governance Programs & Grants Meetings Design Documents Security Audits Start Here Performance & Stability How-to articles Incident Reports Besu Roadmap & Planning How to Contribute You‘re viewing this with anonymous access, so some content might be blocked. Close Besu / Preview the documentation More actions Preview the documentation Felipe Faraggi Nicolas Massart Sally MacFarlane +2 Owned by Felipe Faraggi Last updated: Jul 20, 2022 by Nicolas Massart Preview the Besu documentation with MkDocs on your local machine and on Read the Docs. Preview locally We recommend previewing your work locally before pushing your changes in a PR. Since the final documentation is built with MkDocs, you must build the documentation locally with MkDocs to ensure the Markdown is correctly rendered. To preview the documentation locally: Install Python 3. Create a virtual environment for the project: python3 -m venv env Activate the virtual environment: source env/bin/activate An (env) now appears at the beginning of your prompt. Install all the required dependencies in this virtual environment. We use two requirements files because we have an insider (sponsored) version of material design theme and only readthedocs preview and build can use it. You will have to use the non insider version for local preview. There's a few differences but it's mostly compatible and a good smoke test. The real preview is rendered in the PR, see next section. The requirements.txt is for the common dependencies, the requirements-mkdocs-material.txt is for installing the mkdocs material theme. Run command with both requirement files: pip install -r CI/requirements.txt -r CI/requirements-mkdocs-material.txt Run the following command in the project directory: mkdocs serve In the output of this command, follow the link displayed on the line that looks like the following: [I 190206 18:48:47 server:298] Serving on http://127.0.0.1:8000 In this case, go to http://127.0.0.1:8000. You can let this server run while you work on the documentation. It updates the local website automatically when you save changes in your Markdown files. Deactivate the virtual environment if you work on another Python project, by running deactivate. You can preview the same documentation site again starting from step 3 and skipping step 4, until you update Python. Preview on Read the Docs When you create a PR on a documentation repository, the PR triggers CircleCI checks to verify links, Markdown syntax, writing style, and more. The documentation is also built on Read the Docs (RTD) as a PR preview. This preview uses the insider version of material theme for MkDocs. You can find the link to this preview in the checklist at the bottom of your PR page. The preview only works for registered and permitted RTD users. Ask for help on Discord if needed. , multiple selections available, Related content More info Collapse Versioned documentation Versioned documentation Besu More like this Suggest documentation enhancements Suggest documentation enhancements Besu More like this Documentation release process Documentation release process Besu More like this Report bugs in the documentation Report bugs in the documentation Besu More like this Documentation contribution workflow Documentation contribution workflow Besu More like this Documentation contribution guidelines Documentation contribution guidelines Besu More like this {"serverDuration": 13, "requestCorrelationId": "1edd9c9d542245048fc63b747b445221"}