search

gcanti / docs-ts

A zero-config documentation tool for my TypeScript projects
https://gcanti.github.io/docs-ts/
MIT License
100 stars 17 forks source link

Make aux/github link configurable #26

Closed StefanoMagrassi closed 3 years ago

StefanoMagrassi commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

@IMax153 the projectHomepage field would be fine