XiangShan User Guide

Build

We use Pandoc and MkDocs to build the document.

Pandoc

Pandoc is used to build PDF and single-page HTML documents.

# Install dependencies
bash ./utils/dependency.sh

# Build PDF
make pdf

# Build PDF for print
make pdf TWOSIDE=1

# Build HTML (not ready)
make html

# Build default format (PDF)
make

MkDocs

MkDocs is used to build and deploy a static website on the internet

# Create and Activate Python Virtual Environments (Recommended)
python3 -m venv .venv
source .venv/bin/activate

# Install dependencies
pip install -r ./utils/requirements.txt

# Preview the website
mkdocs serve

# Build the website
mkdocs build

LICENSE

This document is licensed under CC BY 4.0.

Copyright © 2024 The XiangShan Team, Beijing Institute of Open Source Chip