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

pkgdown home page #91

Open
earowang opened this issue Feb 16, 2022 · 3 comments
Open

pkgdown home page #91

earowang opened this issue Feb 16, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@earowang
Copy link
Collaborator

It would be good that the two examples on README can be interactive for the pkgdown site. For example, https://g2r.opifex.org and they use index.md https://github.com/devOpifex/g2r/blob/master/index.md to overwrite README

@earowang earowang added the documentation Improvements or additions to documentation label Feb 16, 2022
@casperhart
Copy link
Owner

The g2r example embeds a custom html file (pkgdown/embed.html) within index.md, and I suspect embed.md is not auto generated.

I've tried to generate an index.md from an index.Rmd that includes the JS dependencies for {detourr} but so far I've had no luck. It contains the data for the tour, but not the code.

---
title: "`{detourr}`"
always_allow_html: yes
output:
  md_document
---

Any ideas?

@earowang
Copy link
Collaborator Author

Their embed.md is pre-saved.

Hmm, maybe try html_document instead of md_document? Not sure how pkgdown uses JS bundles.

@earowang
Copy link
Collaborator Author

earowang commented Feb 23, 2022

If you want to automatically generate these plots, you might try it out with Docker + pkgdown using GH actions. I don't know how to do this, but you can experiment it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants