Skip to content

Commit 67bf108

Browse files
committed
Update docs.yml to install mkdocs-redirects
1 parent f82c4ac commit 67bf108

File tree

4 files changed

+11
-0
lines changed

4 files changed

+11
-0
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,5 @@ jobs:
3232
restore-keys: |
3333
mkdocs-material-
3434
- run: pip install mkdocs-material
35+
- run: pip install mkdocs-redirects
3536
- run: mkdocs gh-deploy --force -f docs/mkdocs.yml

docs/mkdocs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@ extra:
5353
- icon: fontawesome/brands/x-twitter
5454
link: https://twitter.com/dbaileychess
5555

56+
plugins:
57+
# https://github.com/mkdocs/mkdocs-redirects
58+
- redirects:
59+
redirect_maps:
60+
'flatbuffers_guide_use_cpp.html.md': 'cpp.md'
5661

5762

5863
markdown_extensions:
@@ -88,6 +93,8 @@ nav:
8893
- Overview: "schema.md"
8994
- Evolution: "evolution.md"
9095
- Grammar: "grammar.md"
96+
- Language Guides:
97+
- C++: "cpp.md"
9198
- Advanced:
9299
- Annotating Buffers (.afb): "annotation.md"
93100
- Contributing: "contributing.md"

docs/source/contributing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ other ways)
6464

6565
```
6666
pip install mkdocs-material
67+
pip install mkdocs-redirects
6768
```
6869

6970
Then, in the `root` directory of flatbuffers, run

docs/source/cpp.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Language Guide: C++
2+

0 commit comments

Comments
 (0)