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

Generating github links without git #394

Closed
jmlopez-rod opened this issue Jan 27, 2017 · 2 comments
Closed

Generating github links without git #394

jmlopez-rod opened this issue Jan 27, 2017 · 2 comments

Comments

@jmlopez-rod
Copy link

Is there a way to generate links to Github without having the repository? Say I download a zip file of the project and try to generate the documentation. We know the github url from the package.json

  "repository": {
    "type": "git",
    "url": "git://github.com/TypeStrong/TypeDoc.git"
  },

The generated docs may not be in sync since the code will not know what branch its supposed to look at. We could by default just make it point to master. Docs and code may be out of sync but that's a risk we are willing to take. To avoid this we could add another field to package.json specifying the branch name or commit to point it to or maybe an option in the command line.

Our internal doc generation involves using docker and we no longer have the repo when we make the docs and so all the links pointing to Github are not generated.

@aciccarello
Copy link
Collaborator

Related to (but different from) #129

@jmlopez-rod
Copy link
Author

@aciccarello indeed, the other issue would solve this. Thanks.

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