x3plus_docs

This is the project documentation for the x3plus project.

Introduction

This is the source for a collection of booklets or alternatively a web site which describe the journey exploring the robot space.

Build the books

Install required tools for PDF generation on Windows

To generate the books as PDF the following tools are required.

choco install vscode -y
choco install git -y
choco install miktex -y
choco install pandoc -y
choco install powershell-core -y
choco install plantuml -y

Generate the books

Use the powershell script to generate the PDFs

GenerateBooks.ps1

Build the Mkdocs web site

Install required tools for mkdocs on Windows

To run the Website generation locally install the following tools.

choco install mkdocs -y
choco install python3 -y
pip install mkdocs-material
pip install mkdocs-literate-nav
pip install mkdocs-git-revision-date-localized-plugin
pip install mkdocs-bibtex

Then the website can run locally with

mkdocs serve

Github Pages

The web site of the project can be found under

Github Pages