flatbuffers/docs
2025-08-06 22:06:44 -07:00
..
overrides Remove old documentation 2025-02-10 20:13:39 -08:00
source Doc fix verifier example code for cpp (#8664) 2025-08-06 13:53:44 -07:00
mkdocs.yml Fix JavaScript typo in mkdocs.yml (#8515) 2025-07-17 17:53:12 +00:00
README.md docs: fix broken link in readme (#8656) 2025-08-06 22:06:44 -07:00

Documentation

This is the source of the FlatBuffers documentation, that is served at https://flatbuffers.dev.

Local Building

The documentation can be built and served locally during development, see https://flatbuffers.dev/contributing/#local-development for full details.

tl;dr

Install:

pip install mkdocs-material
pip install mkdocs-redirects

Build and Serve:

mkdocs serve -f docs/mkdocs.yml