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

Improved documentation #47

Open
jhelvy opened this issue Feb 3, 2022 · 1 comment
Open

Improved documentation #47

jhelvy opened this issue Feb 3, 2022 · 1 comment

Comments

@jhelvy
Copy link
Owner

jhelvy commented Feb 3, 2022

I'm starting this issue just to brainstorm some ideas for improving the package documentation.

One way to structure the documentation is to essentially move a lot of what is in the main readme file to separate articles. Perhaps these articles:

  • Installation: I think a separate page on this might be nice since the chrome requirement is easy to miss. 
  • Compile slides to an HTML page: This would just be build_html(). It probably doesn't need it's own page, but I don't konw where else to put it.
  • Build slides to a PDF: PDF is probably the most common output type, plus the complex / partial slides bit could be explained here in detail.
  • Get PNGs of all or select slides: This would include build_png() and build_social(). Examples could include building from a {xaringan} deck (the .Rmd file) as well as perhaps building from a PDF of a .pptx file.
  • Animate your slides as a GIF or MP4: This would include build_gif() and build_mp4(). Again, could show examples of building from the .Rmd file or a PDF of a .pptx file.
  • Convert your slides to a PPTX: This would include build_pptx().
@jhelvy
Copy link
Owner Author

jhelvy commented Feb 3, 2022

Maybe also include a Troubleshooting article for some common issues, like this one about images exceeding the slide boundaries.

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