{"id":13857891,"url":"https://github.com/jumpingrivers/headR","last_synced_at":"2025-07-13T22:31:22.125Z","repository":{"id":75642405,"uuid":"146879712","full_name":"jumpingrivers/headR","owner":"jumpingrivers","description":"Adding meta cards to Rmd files","archived":true,"fork":false,"pushed_at":"2022-05-04T10:23:04.000Z","size":788,"stargazers_count":17,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-22T15:41:28.877Z","etag":null,"topics":["knitr","rmd-document","rstats"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jumpingrivers.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-08-31T10:50:47.000Z","updated_at":"2024-08-22T14:39:20.000Z","dependencies_parsed_at":"2023-06-07T05:30:13.072Z","dependency_job_id":null,"html_url":"https://github.com/jumpingrivers/headR","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jumpingrivers/headR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpingrivers%2FheadR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpingrivers%2FheadR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpingrivers%2FheadR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpingrivers%2FheadR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jumpingrivers","download_url":"https://codeload.github.com/jumpingrivers/headR/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jumpingrivers%2FheadR/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265218209,"owners_count":23729496,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["knitr","rmd-document","rstats"],"created_at":"2024-08-05T03:01:49.809Z","updated_at":"2025-07-13T22:31:21.658Z","avatar_url":"https://github.com/jumpingrivers.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"---\noutput:\n  md_document:\n    variant: markdown_github\neditor_options: \n  chunk_output_type: console\n---\n\n```{r, echo = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"README-\" \n)\n```\n\n# HeadR  \u003cimg src=\"man/img/logo.png\" align=\"right\" /\u003e\n\n[![Build Status](https://travis-ci.org/jumpingrivers/headR.svg?branch=master)](https://travis-ci.org/jumpingrivers/headR)\n\n__headR__ is an R package for creating html summary cards for your R markdown files. These cards\nare located in the meta tags of generated HTML document and allow you add richer\ncontent when sharing your site.\n\nTo install the package, you need the __devtools__ package\n```{r, eval = FALSE}\ndevtools::install_github(\"jumpingrivers/headR\")\n```\n\n## Twitter Cards\n\nWhen a URL is shared on twitter, the web page is parsed to determine if\na [twitter card](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/guides/getting-started.html) is present. \n\nFor example, the following pages have twitter cards:\n\n * [Twitter card](https://www.jumpingrivers.com/rpackages/headr/vignettes/twitter_large.html)\n * [Twitter card + Slides](https://www.jumpingrivers.com/rpackages/headr/vignettes/twitter_slides.html)\n\n\nTo preview the twitter card for these document, simply copy and paste the page URL into the [twitter card validator](https://cards-dev.twitter.com/validator). \n \nWhen the links are shared via twitter, the bespoke card is displayed!\n\n## The package\n\nHeadR currently supports two types of meta tags: twitter and open graph. Usually you would have to write meta tags within your html file for them to have a visually appealing sharing format. An example of how you would add these meta tags to your Rmd document is as shown:\n\n```\n---   \noutput: \n  html_document: \n    includes:\n      in_header: twitter_card.html\n---\n```\n\nThe file `twitter_card.html` contains meta tag information is the output of running the function `headR::add_twitter_card()`. More specifically:\n\n```{r, eval = FALSE}\nheadR::add_twitter_card(title = \"This is the title!\", \n                        file = \"twitter_card.html\", \n                        image = \"http://www.example.com/path.jpg\")\n```\n\n---\n\nDevelopment of this package was supported by [Jumping Rivers](https://www.jumpingrivers.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjumpingrivers%2FheadR","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjumpingrivers%2FheadR","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjumpingrivers%2FheadR/lists"}