Skip to content
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.

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

Add ability to configure docs page metadata #3592

Closed
Simek opened this issue Oct 15, 2020 · 1 comment
Closed

Add ability to configure docs page metadata #3592

Simek opened this issue Oct 15, 2020 · 1 comment
Labels
proposal This issue is a proposal, usually non-trivial change

Comments

@Simek
Copy link
Contributor

Simek commented Oct 15, 2020

💥 Proposal

Currently the docs pages metadata is hardcoded and there is no option to customize it. It is not a separate component, but it is a part of DocItem file which makes the swizzle a bit risky. There are also no dedicated CSS class names which will help the users to customize the appearance of metadata.

What would be nice to see:

  • docs page metadata extracted to the separate component
  • unique CSS class by default for those who don't want to swizzle, but want to tweak the design a bit
  • ability to specify maximum number of last contributors from 1 to 5 (hardcoded: 1)
  • ability to specify the handle by which user is represented (hardcoded: name + surname)
    • as possible value it would be nice to have GitHub username, email or one of names used alone
  • ability to display user avatar or profile picture from GitHub (or Gravatar) with a nice fallback
  • ability to customize the date format, including the relative formatting (hardcoded: DD/MM/YYYY)

Ideally it would be good to have customizability at the level which allow to create the similar solution to the one used by GitBook, few examples (you need to scroll to the bottom of the pages):

Originally reported in: react-native-website-migration/react-native-website#37

Have you read the Contributing Guidelines on issues?

Yes

@Simek Simek added status: needs triage This issue has not been triaged by maintainers proposal This issue is a proposal, usually non-trivial change labels Oct 15, 2020
@Josh-Cena
Copy link
Collaborator

Josh-Cena commented Feb 10, 2022

Closing in favor of #6218. We'll likely expose an API to bring your own way to retrieve authors data. The other two points unrelated to authors profile are probably already resolved. The date format will be resolved by #6430.

@Josh-Cena Josh-Cena removed the status: needs triage This issue has not been triaged by maintainers label Mar 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal This issue is a proposal, usually non-trivial change
Projects
None yet
Development

No branches or pull requests

2 participants