docs: TOC doesn't work for content importing from other files

[suyanhanx]

An issue of Docusaurus.

related issue: https://github.com/facebook/docusaurus/issues/3915

[tisonkun]

How can this issue affect opendal's site? Can you share the related pages so that one can investigate into it?

[suyanhanx]

Currently, many of our documents are placed together with code. This approach brings the code and documents closer together, making maintenance easier. We import these documents directly into the website's pages to better integrate them with the website. However, due to issues with Docusaurus, the imported documents fail to render their TOCs correctly.

Here is an example: https://opendal.apache.org/docs/services/s3

There is only one line in this page's TOC.

This anchor point was written in this page file. That means only the TOCs for the actual content in the page file is rendered, while the imported parts are not.

[Xuanwo]

https://github.com/facebook/docusaurus/issues/3915 has been closed and this fix will land in docusaurus 3.2

[suyanhanx]

facebook/docusaurus#3915 has been closed and this fix will land in docusaurus 3.2

Wow, that's great.

[Xuanwo]

docusaurus 3.2 released and we don't need this feature anymore.