forked from BigfootDev/flatbuffers
25 lines
430 B
Markdown
25 lines
430 B
Markdown
# 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
|
|
```
|