facebook / facebook/docusaurus

Ability to expose extra docs data to existing pages (ex: expose frontMatter in tags pages)

Open
#8,886 3 comments 0 reactions 0 assignees View on GitHub
proposal
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).

### Motivation

I want to expose more data from docs inside auto-generated tags pages (DocTagDocListPage).

Currently, there are only few things exposed ( `docusaurus/packages/docusaurus-plugin-content-docs/src/props.ts` ):
- id
- title
- description
- permalink

Generated tags pages are simple. I would like to improve them a lot by using more data from docs like front matter, especially since I've got a lot of custom front matter attributes.
For now, modifying & extending tags pages is very limited due to limited info.

Since those pages are generated outside of DocProviders, i didn't find a way to fetch more data otherwise that modify whole plugin workflow ( probably modifying `contentLoaded` function )

Moreover, I don't understand why currently only those 4 fields are exposed for tags pages.

### Self-service

- [X] I'd be willing to do some initial work on this proposal myself.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.