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 #37

Closed
Simek opened this issue Oct 12, 2020 · 3 comments
Closed

Add ability to configure docs page metadata #37

Simek opened this issue Oct 12, 2020 · 3 comments

Comments

@Simek
Copy link

Simek commented Oct 12, 2020

Description

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 I have to sizzle to removed the version badge from current docs, adjust styling and add CSS class to metadata block to be able to customize the design of it.

What would be nice to see:

  • 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 disable the date (hardcoded: always visible)
  • ability to customize the date format, including the relative formatting (hardcoded: DD/MM/YYYY)

From my perspective this is not a migration blocker rather a feature idea/request.

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):

@slorber
Copy link

slorber commented Oct 14, 2020

Yeah that would be a nice enhancement.
Wonder if reading n last contributors could affect build time.

Do you have the doc that shows the API to customize this part in Gitbook?

@Simek
Copy link
Author

Simek commented Oct 14, 2020

@slorber GitBook is not a Open Source project. From my tests on the free tier there is no option to customize the page contributors (it looks like this feature is a part of their GitHub integration).

@slorber
Copy link

slorber commented Oct 15, 2020

@Simek I think this issue should rather be opened on Docusaurus repo, as it's not something we had on v1, so not really part of the migration, yet would be a nice improvement for all Docusaurus users

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants