Update docs.yml to install mkdocs-redirects

This commit is contained in:
Derek Bailey 2025-01-09 22:06:12 -08:00
parent f82c4ac904
commit 67bf1084c0
4 changed files with 11 additions and 0 deletions

View File

@ -32,4 +32,5 @@ jobs:
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: pip install mkdocs-redirects
- run: mkdocs gh-deploy --force -f docs/mkdocs.yml

View File

@ -53,6 +53,11 @@ extra:
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/dbaileychess
plugins:
# https://github.com/mkdocs/mkdocs-redirects
- redirects:
redirect_maps:
'flatbuffers_guide_use_cpp.html.md': 'cpp.md'
markdown_extensions:
@ -88,6 +93,8 @@ nav:
- Overview: "schema.md"
- Evolution: "evolution.md"
- Grammar: "grammar.md"
- Language Guides:
- C++: "cpp.md"
- Advanced:
- Annotating Buffers (.afb): "annotation.md"
- Contributing: "contributing.md"

View File

@ -64,6 +64,7 @@ other ways)
```
pip install mkdocs-material
pip install mkdocs-redirects
```
Then, in the `root` directory of flatbuffers, run

2
docs/source/cpp.md Normal file
View File

@ -0,0 +1,2 @@
# Language Guide: C++