diff --git a/.github/workflows/deploy-mkdocs.yml b/.github/workflows/deploy-mkdocs.yml index 9d4ad4be41..3235bcd4e1 100644 --- a/.github/workflows/deploy-mkdocs.yml +++ b/.github/workflows/deploy-mkdocs.yml @@ -25,6 +25,7 @@ jobs: python -m pip install --upgrade pip pip install mkdocs mkdocs-material pip install mkdocs-video + pip install mkdocs-redirects - name: Build MkDocs site run: mkdocs build diff --git a/README.md b/README.md index e61f95d080..1fda557a88 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ This is the BNBChain Knowledge Base documentation for the BNBChain developers. I * `pip install mkdocs-material` - install mkdocs-material. * `pip install mkdocs-video` - install mkdocs-video. +* `pip install mkdocs-redirects` - install mkdocs-redirects plugin. ## Commands diff --git a/mkdocs.yml b/mkdocs.yml index 17f9c58560..8c39b781f2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -310,6 +310,9 @@ markdown_extensions: plugins: - search - mkdocs-video + - redirects: + redirect_maps: + 'docs.md': 'bnb-smart-chain/index.md' extra_css: - https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@300..700&display=swap