Skip to content

docs: mention Docusaurus requires trailingSlash: true #12397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: mention Docusaurus requires trailingSlash: true #12397

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/user/intro/docusaurus.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ build the site, and copy the output to $READTHEDOCS_OUTPUT:

.. _Docusaurus: https://docusaurus.io/

.. note::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the note -- we have some example config options noted below, this section should be put there around liune 75.


On Read the Docs, Docusaurus should set 'trailingSlash: true' in
'docusaurus.config.js' to avoid routing issues. If you set it to
'false', you will need to define appropriate redirects.


Limitations
-----------

Expand Down