• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1site_name: FlatBuffers Docs
2docs_dir: source
3site_url: https://flatbuffers.dev
4repo_name: google/FlatBuffers
5repo_url: https://github.com/google/flatbuffers
6edit_uri: edit/master/docs/source/
7copyright: Copyright © 2025 Google
8theme:
9  name: material
10  logo: assets/flatbuffers_logo.svg
11  icon:
12    repo: fontawesome/brands/github
13  custom_dir: overrides
14  palette:
15    # Palette toggle for light mode
16    - scheme: default
17      toggle:
18        icon: material/brightness-7
19        name: Switch to dark mode
20
21    # Palette toggle for dark mode
22    - scheme: slate
23      toggle:
24        icon: material/brightness-4
25        name: Switch to light mode
26
27  features:
28    # Allows code block annotations
29    - content.code.annotate
30
31    # Allows content tabs to link together
32    - content.tabs.link
33
34    # Expand nav folders by default
35    - navigation.expand
36
37    # Enable the footer
38    - navigation.footer
39
40    # Auto hide the header after scrolling
41    - header.autohide
42
43    - content.action.edit
44
45extra:
46  social:
47    - icon: fontawesome/brands/github
48      link: https://github.com/google/flatbuffers
49
50    - icon: fontawesome/brands/discord
51      link: https:///discord.gg/6qgKs3R
52
53    - icon: fontawesome/brands/x-twitter
54      link: https://twitter.com/dbaileychess
55
56plugins:
57  # Use redirects to update links from the original docs to the new ones.
58  #
59  # https://github.com/mkdocs/mkdocs-redirects
60  - redirects:
61      # Note the .html are suffixed with .md to avoid warnings. Got from
62      # https://github.com/mkdocs/mkdocs-redirects/issues/51#issuecomment-2408548029
63      redirect_maps:
64        'flatbuffers_guide_building.html.md': 'building.md'
65        'flatbuffers_guide_tutorial.html.md': 'tutorial.md'
66        'flatbuffers_guide_using_schema_compiler.html.md': 'flatc.md'
67        'flatbuffers_guide_writing_schema.html.md': 'schema.md'
68        'md__schemas.html.md': 'schema.md' # issue #8485
69        'flatbuffers_guide_use_c.html.md': 'languages/c.md'
70        'flatbuffers_guide_use_cpp.html.md': 'languages/cpp.md'
71        'flatbuffers_guide_use_c-sharp.html.md': 'languages/c_sharp.md'
72        'flatbuffers_guide_use_dart.html.md': 'languages/dart.md'
73        'flatbuffers_guide_use_go.html.md': 'languages/go.md'
74        'flatbuffers_guide_use_java.html.md': 'languages/java.md'
75        'flatbuffers_guide_use_javascript.html.md': 'languages/javascript.md'
76        'flatbuffers_guide_use_lobster.html.md': 'languages/lobster.md'
77        'flatbuffers_guide_use_lua.html.md': 'languages/lua.md'
78        'flatbuffers_guide_use_php.html.md': 'languages/php.md'
79        'flatbuffers_guide_use_python.html.md': 'languages/python.md'
80        'flatbuffers_guide_use_rust.html.md': 'languages/rust.md'
81        'flatbuffers_guide_use_swift.html.md': 'languages/swift.md'
82        'flatbuffers_guide_use_typescript.html.md': 'languages/typescript.md'
83        'flatbuffers_grpc_guide_use_cpp.html.md' : "languages/cpp.md#grpc"
84        'flatbuffers_support.html.md': 'support.md'
85        'flatbuffers_white_paper.html.md': 'white_paper.md'
86        'flatbuffers_grammar.html.md': 'grammar.md'
87        'flatbuffers_internals.html.md': 'internals.md'
88        'intermediate_representation.html.md': 'intermediate_representation.md'
89        'flatbuffers_benchmarks.html.md': 'benchmarks.md'
90        'flexbuffers.html.md': 'flexbuffers.md'
91        'contributing.html.md': 'contributing.md'
92
93
94markdown_extensions:
95  - admonition
96  - attr_list
97  - md_in_html
98  - pymdownx.critic
99  - pymdownx.details
100  - pymdownx.emoji:
101      emoji_index: !!python/name:material.extensions.emoji.twemoji
102      emoji_generator: !!python/name:material.extensions.emoji.to_svg
103  - pymdownx.snippets:
104      # Allows direct embedded of remote files
105      url_download: true
106  - pymdownx.superfences
107  - pymdownx.tabbed:
108      alternate_style: true
109      slugify: !!python/object/apply:pymdownx.slugs.slugify
110        kwds:
111          case: lower
112  - pymdownx.highlight:
113      extend_pygments_lang:
114        # PHP wasn't highlighting correctly. This is a work around found
115        # https://github.com/squidfunk/mkdocs-material/issues/138#issuecomment-2294025627
116        - name: php
117          lang: php
118          options:
119            startinline: true
120  - tables
121
122
123
124nav:
125  - Overview: "index.md"
126  - Quick Start: "quick_start.md"
127  - Tutorial: "tutorial.md"
128  - Compiler (flatc):
129    - Building: "building.md"
130    - Using: "flatc.md"
131  - Schema (.fbs):
132    - Overview: "schema.md"
133    - Evolution: "evolution.md"
134    - Grammar: "grammar.md"
135  - Language Guides:
136    - C: "languages/c.md"
137    - C++: "languages/cpp.md"
138    - C#: "languages/c_sharp.md"
139    - Dart: "languages/dart.md"
140    - Go: "languages/go.md"
141    - Java: "languages/java.md"
142    - JavasScript: "languages/javascript.md"
143    - Kotlin: "languages/kotlin.md"
144    - Lobster: "languages/lobster.md"
145    - Lua: "languages/lua.md"
146    - PHP: "languages/php.md"
147    - Python: "languages/python.md"
148    - Rust: "languages/rust.md"
149    - Swift: "languages/swift.md"
150    - TypeScript: "languages/typescript.md"
151  - Supported Configurations: "support.md"
152  - White Paper: "white_paper.md"
153  - Advanced:
154    - FlatBuffers Internals: "internals.md"
155    - Intermediate Representation: "intermediate_representation.md"
156    - Annotating Buffers (.afb): "annotation.md"
157    - Benchmarks: "benchmarks.md"
158  - FlexBuffers (Schema-less version): "flexbuffers.md"
159  - Contributing: "contributing.md"
160