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 other code hosts #1238

Closed
hadley opened this issue Mar 11, 2020 · 2 comments · Fixed by #1253
Closed

Support other code hosts #1238

hadley opened this issue Mar 11, 2020 · 2 comments · Fixed by #1253
Labels
feature a feature request or enhancement linking 📎
Milestone

Comments

@hadley
Copy link
Member

hadley commented Mar 11, 2020

e.g. GitHub enterprise (#676), GitLab (#1045), and sub-directories (#1152)

This requires at least the ability to configure the following URLs:

  • A home page, equivalent to (e.g.) https://github.com/r-lib, for the navbar.
  • A source url, equivalent to (e.g.) https://github.com/r-lib/pkgdown/blob/master/{path}, for reference and article source links.
  • An issue url, equivalent to (e.g.) https://github.com/r-lib/issues/{number}, for NEWS links.
  • A person url, equivalent to (e.g.) https://github.com/{username}, for NEWS links.
@hadley
Copy link
Member Author

hadley commented Mar 12, 2020

To do:

  • Rename github_source_links() to source_links() and change first argument to full package object

  • Rename add_github_links() to ??? and use issue and name urls. This will require switching to some more complex form of text replacement.

I think we could probably leave the navbar off since you're likely to want to change the icon too if you're not on GitHub.

@hadley
Copy link
Member Author

hadley commented Mar 16, 2020

Hmmm, currently GHE, GitLab, and subdirectories as have exactly the same form as github, so it might not be worth generalising too much at this point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement linking 📎
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant