facebook / facebook/docusaurus
Generate index page with table of content
- Dominant language
- TypeScript
- Stars
- 66.2k
- Forks
- 10k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 52
Description
### Have you read the Contributing Guidelines on issues?
- [X] I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#issues).
### Description
Generate index page with optional table of content, which namely adding some list `` on here: https://github.com/facebook/docusaurus/blob/d07567e411410e6b7f14ca8f7c2c3b501f58b9ad/packages/docusaurus-theme-classic/src/theme/DocCard/index.tsx#L62-L68
And here should be adding extra table of content of some document links on return:
https://github.com/facebook/docusaurus/blob/d07567e411410e6b7f14ca8f7c2c3b501f58b9ad/packages/docusaurus-theme-common/src/utils/docsUtils.tsx#L118
Prevents me from raising an ISSUE instead of PR is the second point.
### Has this been requested on Canny?
_No response_
### Motivation
The original generated index is fine for link, but not good for doucment.
Because the document title should enough summarize topic of this section doucment, you may want get more information form this page, otherwise this page was no that useful, opinion only of mine.
This is a example likes this ISSUE:
### API design
_No response_
### Have you tried building it?
_No response_
### Self-service
- [ ] I'd be willing to contribute this feature to Docusaurus myself.
Contributor guide
Assessment
This issue has not been assessed yet.