Skip to content

Commit

Permalink
Update docs.yml to install mkdocs-redirects
Browse files Browse the repository at this point in the history
  • Loading branch information
dbaileychess committed Jan 10, 2025
1 parent f82c4ac commit 67bf108
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
7 changes: 7 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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"
1 change: 1 addition & 0 deletions docs/source/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ other ways)

```
pip install mkdocs-material
pip install mkdocs-redirects
```

Then, in the `root` directory of flatbuffers, run
Expand Down
2 changes: 2 additions & 0 deletions docs/source/cpp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Language Guide: C++

0 comments on commit 67bf108

Please sign in to comment.