mirror of
https://github.com/google/flatbuffers.git
synced 2026-06-28 07:58:05 +00:00
Update docs.yml to install mkdocs-redirects
This commit is contained in:
1
.github/workflows/docs.yml
vendored
1
.github/workflows/docs.yml
vendored
@@ -32,4 +32,5 @@ jobs:
|
|||||||
restore-keys: |
|
restore-keys: |
|
||||||
mkdocs-material-
|
mkdocs-material-
|
||||||
- run: pip install mkdocs-material
|
- run: pip install mkdocs-material
|
||||||
|
- run: pip install mkdocs-redirects
|
||||||
- run: mkdocs gh-deploy --force -f docs/mkdocs.yml
|
- run: mkdocs gh-deploy --force -f docs/mkdocs.yml
|
||||||
|
|||||||
@@ -53,6 +53,11 @@ extra:
|
|||||||
- icon: fontawesome/brands/x-twitter
|
- icon: fontawesome/brands/x-twitter
|
||||||
link: https://twitter.com/dbaileychess
|
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:
|
markdown_extensions:
|
||||||
@@ -88,6 +93,8 @@ nav:
|
|||||||
- Overview: "schema.md"
|
- Overview: "schema.md"
|
||||||
- Evolution: "evolution.md"
|
- Evolution: "evolution.md"
|
||||||
- Grammar: "grammar.md"
|
- Grammar: "grammar.md"
|
||||||
|
- Language Guides:
|
||||||
|
- C++: "cpp.md"
|
||||||
- Advanced:
|
- Advanced:
|
||||||
- Annotating Buffers (.afb): "annotation.md"
|
- Annotating Buffers (.afb): "annotation.md"
|
||||||
- Contributing: "contributing.md"
|
- Contributing: "contributing.md"
|
||||||
|
|||||||
@@ -64,6 +64,7 @@ other ways)
|
|||||||
|
|
||||||
```
|
```
|
||||||
pip install mkdocs-material
|
pip install mkdocs-material
|
||||||
|
pip install mkdocs-redirects
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, in the `root` directory of flatbuffers, run
|
Then, in the `root` directory of flatbuffers, run
|
||||||
|
|||||||
2
docs/source/cpp.md
Normal file
2
docs/source/cpp.md
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
# Language Guide: C++
|
||||||
|
|
||||||
Reference in New Issue
Block a user