flatbuffers/docs
Derek Bailey 2d86857bec
Add Annotating Docs (#8470)
* `quick_start.md`: Add quick start guide

* `annotation.md`: Add section on annotating flatbuffers
2024-12-27 11:25:21 -08:00
..
overrides Add new Docs source files (#8461) 2024-12-23 15:55:56 -08:00
source Add Annotating Docs (#8470) 2024-12-27 11:25:21 -08:00
mkdocs.yml Add Annotating Docs (#8470) 2024-12-27 11:25:21 -08:00
README.md contributions.md Add doc about how to contribute to flatbuffers (#8464) 2024-12-23 22:06:04 -08: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

Build and Serve:

mkdocs serve -f docs/mkdocs.yml