Documentation: show examples of using htmlDependency

Open
#362 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
r
Domain
documentation

Research direction

Start with the htmlDependency() documentation and review existing usages in the htmltools repository to identify common patterns that are difficult to discover. Add a few representative usage examples to the documentation, ensuring they explain how the function is used in Shiny applications.

Written by the indexing model from the issue text.

Description

htmlDependency() is an important function for shiny app developers, yet it's not very easy to understand how to use it by reading the documentation. The documentation is technically complete and has all the required information, but providing a few examples would help a lot.

I personally never remember how to use it and every time I need to use it I end up looking at previous usages, and (anecdotally) from speaking to others that seems to be a common theme.

Dominant language
R
Stars
225
Forks
73
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rstudio/htmltools

All issues in rstudio/htmltools

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.