Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Documentation

This directory contains the source files for the Apache Paimon Rust documentation site, built with MkDocs and the Material for MkDocs theme.

Prerequisites

  • Python 3.8+
  • pip3

Setup

pip3 install mkdocs-material

Development

Preview the docs locally with live reload:

cd docs
mkdocs serve

Then open http://127.0.0.1:8000 in your browser.

Build

Generate the static site:

cd docs
mkdocs build

The output will be in the docs/site/ directory.