{"id":14067306,"url":"https://github.com/ropensci-org/rotemplate","last_synced_at":"2026-03-03T10:30:47.934Z","repository":{"id":41287299,"uuid":"175036493","full_name":"ropensci-org/rotemplate","owner":"ropensci-org","description":"pkgdown template and action to build ropensci docs","archived":false,"fork":false,"pushed_at":"2025-05-17T21:42:58.000Z","size":574,"stargazers_count":25,"open_issues_count":5,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-17T22:28:18.805Z","etag":null,"topics":["pkgdown","r","r-package","rstats"],"latest_commit_sha":null,"homepage":"https://docs.ropensci.org/rotemplate","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/ropensci-org.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-03-11T16:04:47.000Z","updated_at":"2025-05-17T21:43:01.000Z","dependencies_parsed_at":"2023-01-19T02:31:01.571Z","dependency_job_id":"982538c8-23f3-45cd-9bc4-ede20fedfbf0","html_url":"https://github.com/ropensci-org/rotemplate","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ropensci-org/rotemplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-org%2Frotemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-org%2Frotemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-org%2Frotemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-org%2Frotemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ropensci-org","download_url":"https://codeload.github.com/ropensci-org/rotemplate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-org%2Frotemplate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267785800,"owners_count":24144122,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["pkgdown","r","r-package","rstats"],"created_at":"2024-08-13T07:05:31.838Z","updated_at":"2026-03-03T10:30:42.891Z","avatar_url":"https://github.com/ropensci-org.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"# rotemplate \u003ca href='https://docs.ropensci.org/rotemplate'\u003e\u003cimg src='man/figures/logo.png' align=\"right\" height=\"134.5\" /\u003e\u003c/a\u003e\n\nrotemplate provides **a custom pkgdown template** for rOpenSci packages. We\nuse this to render sites at `https://docs.ropensci.org`. Please don’t\nuse it for your own package if it’s not an rOpenSci package (i.e. only\nuse it for packages listed on \u003chttps://ropensci.org/packages/\u003e).\n\nInspired by [tidytemplate](https://github.com/tidyverse/tidytemplate/)\nand [lockedatapkg](https://github.com/lockedatapublished/lockedatapkg).\n\n## How to use `rotemplate`\n\nDocumentation for rOpenSci packages will automatically be generated from\nyour default branch and published to \u003chttps://docs.ropensci.org\u003e. You\ndon’t need to do anything to make this work. To test your site locally use:\n\n``` r\nlibrary(rotemplate)\n#install.packages(\"yourpkg\")\nrotemplate::build_ropensci_docs(\"path/to/yourpkg\")\n```\n\nPreferences can be configured as usual via the `_pkgdown.yml` file\nas described in the pkgdown documentation.\n\nIf your website is not deploying or you run into another problem, please\nopen an issue in the [rotemplate](https://github.com/ropensci-org/rotemplate)\nrepository.\n\n## How it works\n\nThe R-universe [build workflow](https://github.com/r-universe/workflows/blob/HEAD/.github/workflows/build.yml)\nautomatically invokes the rotemplate [action.yml](action.yml) script on each\nupdate of a packages in ropensci. You don't need to do anything for this.\nHowever, if you want to test-build the pkgdown site in your own package CI, \nyou could add the following test workflow to your package repository:\n\n```yml\non:\n  push:\n  pull_request:\n\nname: Test-docs\n\njobs:\n  Test-docs:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: ropensci-org/rotemplate@main\n```\n\nThis will run exactly the same script to build the ropensci pkgdown site, and\nstore it as an GHA artifact where you can download it to view it locally.\n\n### Math rendering\n\nPlease refer to [pkgdown documentation](https://pkgdown.r-lib.org/dev/articles/customise.html#math-rendering).\n\n\n## Example sites\n\n-   [`cyphr`](https://docs.ropensci.org/cyphr/)\n\n-   [`drake`](https://docs.ropensci.org/drake/)\n\n-   [`riem`](https://docs.ropensci.org/riem/)\n\n-   [`rotl`](https://docs.ropensci.org/rotl/)\n\n-   [`stplanr`](https://docs.ropensci.org/stplanr/)\n\n-   [`visdat`](http://visdat.njtierney.com/)\n\n-   [`magick`](https://docs.ropensci.org/magick/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci-org%2Frotemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fropensci-org%2Frotemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci-org%2Frotemplate/lists"}