diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bcae8fa4c..cac856182 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -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 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 3e961f8c7..cec8dd088 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -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" diff --git a/docs/source/contributing.md b/docs/source/contributing.md index 74461ce24..a65b60ac5 100644 --- a/docs/source/contributing.md +++ b/docs/source/contributing.md @@ -64,6 +64,7 @@ other ways) ``` pip install mkdocs-material +pip install mkdocs-redirects ``` Then, in the `root` directory of flatbuffers, run diff --git a/docs/source/cpp.md b/docs/source/cpp.md new file mode 100644 index 000000000..a9bb0265c --- /dev/null +++ b/docs/source/cpp.md @@ -0,0 +1,2 @@ +# Language Guide: C++ +