tree: df47d5b83b82dcd72186b7ded5c8380229c15dfc [path history] [tgz]
  1. overrides/
  2. source/
  3. mkdocs.yml
  4. README.md
docs/README.md

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