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

Add a {pkgdown} reference website? #5

Open
trevorld opened this issue May 12, 2024 · 1 comment
Open

Add a {pkgdown} reference website? #5

trevorld opened this issue May 12, 2024 · 1 comment

Comments

@trevorld
Copy link

trevorld commented May 12, 2024

  • I think usethis::use_pkgdown_github_pages() will automatically set up everything including the relevant Github Actions needed to automatically build such a website after repo pushes using a github.io url: https://usethis.r-lib.org/reference/use_pkgdown.html
  • Alternatively you could build a website locally in a directory using: pkgdown::build_site() and then rsync the files to a website directory you control (this is what I do with my own packages)
  • A good idea to add links to this site on the DESCRIPTION and upper right description on Github
@trevorld
Copy link
Author

trevorld commented May 12, 2024

For {bittermelon}'s {pkgdown} website I found I needed to add a CSS tweak in pkgdown/extra.css for the line-height so the fancy print examples would look pretty on the website:

pre {
    font-family: Dejavu Sans Mono,Unifont,monospace;
    line-height: 1.0;
}

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

1 participant