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

Make aux/github link configurable #26

Closed
StefanoMagrassi opened this issue Feb 16, 2021 · 2 comments · Fixed by #29
Closed

Make aux/github link configurable #26

StefanoMagrassi opened this issue Feb 16, 2021 · 2 comments · Fixed by #29
Assignees
Labels
enhancement New feature or request

Comments

@StefanoMagrassi
Copy link

Do you want to request a feature or report a bug?

Feature

What is the current behavior?

In _config.yml the aux_links/github field is automatically set with package.json's homepage value which can be different from repository url

If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://codesandbox.io/ or similar.

What is the expected behavior?

Another field github in docs-ts.json field that will be used as aux_links/github link.

Which versions of docs-ts, and which browser and OS are affected by this issue? Did this work in previous versions of docs-ts?

0.6.2

@IMax153
Copy link
Collaborator

IMax153 commented Feb 20, 2021

Hey @StefanoMagrassi! I think adding this config property is fine, but would you be okay with using the name projectHomepage ?

Since any custom configuration properties provided by the user end up overriding their default value, using the same name for the property in the Config interface and the property in the Settings just makes things easier.

It isn't difficult to change the name to something else though, if everyone feels strongly!

@StefanoMagrassi
Copy link
Author

@IMax153 the projectHomepage field would be fine

@IMax153 IMax153 self-assigned this Feb 23, 2021
@IMax153 IMax153 added the enhancement New feature or request label Feb 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants