| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| # Documentation |
| |
| This directory contains the source files for the Apache Paimon Rust documentation site, built with [MkDocs](https://www.mkdocs.org/) and the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme. |
| |
| ## Prerequisites |
| |
| - Python 3.8+ |
| - pip3 |
| |
| ## Setup |
| |
| ```bash |
| pip3 install mkdocs-material |
| ``` |
| |
| ## Development |
| |
| Preview the docs locally with live reload: |
| |
| ```bash |
| cd docs |
| mkdocs serve |
| ``` |
| |
| Then open [http://127.0.0.1:8000](http://127.0.0.1:8000) in your browser. |
| |
| ## Build |
| |
| Generate the static site: |
| |
| ```bash |
| cd docs |
| mkdocs build |
| ``` |
| |
| The output will be in the `docs/site/` directory. |
