{"id":13734746,"url":"https://github.com/swsoyee/pagemapR","last_synced_at":"2025-05-08T11:30:49.296Z","repository":{"id":47849535,"uuid":"291211558","full_name":"swsoyee/pagemapR","owner":"swsoyee","description":"📦 Quickly and easily add a mini map to web page","archived":false,"fork":false,"pushed_at":"2021-08-27T16:26:27.000Z","size":1155,"stargazers_count":17,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-14T10:31:45.521Z","etag":null,"topics":["htmlwidgets","pagemap","r","rmarkdown","rmarkdown-documents"],"latest_commit_sha":null,"homepage":"https://swsoyee.github.io/pagemapR/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swsoyee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-29T06:03:31.000Z","updated_at":"2024-02-29T03:22:14.000Z","dependencies_parsed_at":"2022-08-21T06:50:44.133Z","dependency_job_id":null,"html_url":"https://github.com/swsoyee/pagemapR","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swsoyee%2FpagemapR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swsoyee%2FpagemapR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swsoyee%2FpagemapR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swsoyee%2FpagemapR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swsoyee","download_url":"https://codeload.github.com/swsoyee/pagemapR/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213758654,"owners_count":15634354,"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":["htmlwidgets","pagemap","r","rmarkdown","rmarkdown-documents"],"created_at":"2024-08-03T03:00:59.428Z","updated_at":"2024-08-03T03:03:58.757Z","avatar_url":"https://github.com/swsoyee.png","language":"R","funding_links":[],"categories":["R","UI Components"],"sub_categories":["Advanced Interactivity"],"readme":"\u003c!--\n%\\VignetteEngine{knitr::rmarkdown}\n%\\VignetteIndexEntry{Introduction to pagemap}\n--\u003e\n\n# pagemapR\n\n\u003cimg src='./vignettes/pagemap.png' width='150' align='right'\u003e\n\n\u003c!-- badges: start --\u003e\n\n[![R build status](https://github.com/swsoyee/pagemapR/workflows/R-CMD-check/badge.svg)](https://github.com/swsoyee/pagemapR/actions)\n[![CRAN\\_Status\\_Badge](https://www.r-pkg.org/badges/version/pagemap)](https://cran.r-project.org/package=pagemap)\n[![metacran downloads](https://cranlogs.r-pkg.org/badges/grand-total/pagemap)](https://cran.r-project.org/package=pagemap)\n\u003c!-- badges: end --\u003e\n\n## Introduction\n\nThis is an R package that provides support for [`pagemap`](https://larsjung.de/pagemap/) as a [`htmlwidgets`](https://www.htmlwidgets.org/).  \nQuickly and easily add a mini map to your rmarkdown `html` documents.\nSee a demonstration [here](https://swsoyee.github.io/pagemapR/).\n\n\u003e Note: To distinguish it from the [original project `pagemap`](https://larsjung.de/pagemap/), the name of this project is `pagemapR`, but the package name is `pagemap`.\n\n## Installation\n\n``` r\ninstall.packages(\"pagemap\")\n```\n\nOr use [`devtools`](https://www.r-project.org/nosvn/pandoc/devtools.html) to install the latest development version.\n\n``` r\n# install.packages(\"devtools\")\ndevtools::install_github(\"swsoyee/pagemapR\")\n```\n\n## Usage\n\nIt’s very simple to use.\n\n``` r\nlibrary(pagemap)\npagemap()\n```\n\nYou could fix it’s position on the screen and style by providing a `list` of css property.\n\n``` r\npagemap(\n  id = \"mini_map\",\n  box_style = list(left = \"5px\", top = \"10px\")\n)\n```\n\nYou could also customize the internal style of the mini map through the API provided by [`pagemap`](https://larsjung.de/pagemap/).\n\n``` r\npagemap(\n  id = \"mini_map\",\n  styles = list(\n    \"h1,h2,a,code\" = \"rgba(0, 0, 0, 0.10)\",\n    \"img\" = \"rgba(0, 0, 0, 0.08)\",\n    \"pre\" = \"rgba(0, 0, 0, 0.04)\"\n  )\n)\n```\n\nOr add a pagemap for your Shiny app:\n\n``` r\nif (interactive()) {\n  shinyApp(\n    ui = fluidPage(pagemapOutput(\"pagemap\")),\n    server = function(input, output) {\n      output$pagemap \u003c- renderPagemap(pagemap())\n    }\n  )\n}\n```\n\n## Credit\n\nThis package is thanks to the work done by **Lars Jung** (\u003chttps://github.com/lrsjng\u003e), the author of the original Javascript package `pagemap`. Also, thanks should also go to Ramnath Vaidyanathan, Kenton Russell, and RStudio, Inc. for the amazing work on create [`htmlwigets`](https://www.htmlwidgets.org/) package. The hex sticker of `pagemap`is produced by [`hexSticker`](https://github.com/GuangchuangYu/hexSticker) and [`ggplot2`](https://ggplot2.tidyverse.org/), so special thanks goes to the **Guangchuang YU** (\u003chttps://guangchuangyu.github.io\u003e) and the `ggplot2` development team.\n\n## Contact\n\nYou are welcome to:\n\n  - Submit suggestions and bug-reports at:\n    \u003chttps://github.com/swsoyee/pagemapR/issues\u003e\n  - Send a pull request on: \u003chttps://github.com/swsoyee/pagemapR\u003e\n  - Compose a friendly e-mail to: \u003cswsoyee@gmail.com\u003e\n\n## Code of Conduct\n\nPlease note that this project is released with a [Contributor Code of Conduct](https://github.com/swsoyee/pagemapR/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswsoyee%2FpagemapR","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswsoyee%2FpagemapR","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswsoyee%2FpagemapR/lists"}