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

Support setting repository url for source links instead of always using git origin remote. #1130

Closed
1 task done
lukaswelinder opened this issue Nov 11, 2019 · 3 comments · Fixed by dbartholomae/redux-dynamic-modules-beacon#25 or gpicron/ssb-subjective-group#1
Projects

Comments

@lukaswelinder
Copy link

Problem

When generating documentation, the "defined in" links always point to the git origin remote, which becomes a pain when trying to update docs on an upstream repository.

Suggested Solution

Allow user to define which git remote or url they wish to use for the repository.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 11, 2019

The soucefile-link plugin does a pretty good job of this already

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 13, 2020

I've changed my mind ^

TypeDoc should support this natively. Users shouldn't need to install a plugin to update docs for an upstream repo.

@Gerrit0 Gerrit0 added this to To do in Backlog via automation Jan 13, 2020
@Gerrit0 Gerrit0 moved this from To do to In progress in Backlog Jan 19, 2020
Gerrit0 added a commit that referenced this issue Jan 20, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 21, 2020

With 0.17.0-1 (beta) you can set the remote with --gitRemote

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Backlog
  
Done
2 participants