flatbuffers/docs
Derek Bailey c9125e6385
flatc.md Add more documentation (#8467)
* CNAME: add custom domain

* `flatc.md`: Add more documentation
2024-12-24 12:15:14 -08:00
..
overrides Add new Docs source files (#8461) 2024-12-23 15:55:56 -08:00
source flatc.md Add more documentation (#8467) 2024-12-24 12:15:14 -08:00
mkdocs.yml contributions.md Add doc about how to contribute to flatbuffers (#8464) 2024-12-23 22:06:04 -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