{"id":21614397,"url":"https://github.com/sciviews/svpkgdown","last_synced_at":"2026-05-10T05:05:09.941Z","repository":{"id":66352150,"uuid":"257051276","full_name":"SciViews/svPkgdown","owner":"SciViews","description":"A pkgdown template for the SciViews site","archived":false,"fork":false,"pushed_at":"2024-08-19T13:31:12.000Z","size":3602,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-24T20:36:31.069Z","etag":null,"topics":["pkgdown","r","r-packages","sciviews","template"],"latest_commit_sha":null,"homepage":"https://www.sciviews.org/svPkgdown/","language":"CSS","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/SciViews.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.md","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-19T16:44:58.000Z","updated_at":"2024-08-19T13:26:29.000Z","dependencies_parsed_at":"2024-08-20T23:16:55.915Z","dependency_job_id":null,"html_url":"https://github.com/SciViews/svPkgdown","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/SciViews%2FsvPkgdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciViews%2FsvPkgdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciViews%2FsvPkgdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciViews%2FsvPkgdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SciViews","download_url":"https://codeload.github.com/SciViews/svPkgdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244265373,"owners_count":20425701,"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":["pkgdown","r","r-packages","sciviews","template"],"created_at":"2024-11-24T22:07:53.371Z","updated_at":"2026-05-10T05:05:09.935Z","avatar_url":"https://github.com/SciViews.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n# ‘pkgdown’ Template for ‘SciViews::R’ Packages \u003ca href=\"https://www.sciviews.org/svPkgdown\"\u003e\u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"138\"/\u003e\u003c/a\u003e\n\n\u003c!-- badges: start --\u003e\n\n[![R-CMD-check](https://github.com/SciViews/svPkgdown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/SciViews/svPkgdown/actions/workflows/R-CMD-check.yaml)\n[![Codecov test\ncoverage](https://codecov.io/gh/SciViews/svPkgdown/branch/main/graph/badge.svg)](https://app.codecov.io/gh/SciViews/svPkgdown?branch=main)\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/svPkgdown)](https://cran.r-project.org/package=svPkgdown)\n[![r-universe\nstatus](https://sciviews.r-universe.dev/badges/svPkgdown)](https://sciviews.r-universe.dev/svPkgdown)\n[![License:\nMIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Lifecycle:\nstable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)\n\n\u003c!-- badges: end --\u003e\n\n\u003e The {svPkgdown} package provides a custom style for SciViews R package\n\u003e sites generated automatically with {pkgdown}. Please don’t use it\n\u003e unmodified for your own purpose outside of the\n\u003e \u003chttps://www.sciviews.org\u003e web site (but you can reuse it as a\n\u003e starting point from your own template if you wish)!\n\nInspired by [tidytemplate](https://github.com/tidyverse/tidytemplate/),\n[lockedatapkg](https://github.com/lockedatapublished/lockedatapkg) and\n[rotemplate](https://github.com/ropensci/rotemplate).\n\n## Installation\n\nBeing specific to SciViews packages, {svPkgdown} will never be available\nfrom CRAN. You can install it from the [SciViews\nR-Universe](https://sciviews.r-universe.dev) this way:\n\n``` r\ninstall.packages(c('svPkgdown', 'pkgdown'),\n  repos = c('https://sciviews.r-universe.dev', 'https://cloud.r-project.org'))\n```\n\nYou can install the latest version of {svPkgdown} from GitHub. Make sure\nyou have the {devtools} R package installed:\n\n``` r\ninstall.packages(\"remotes\")\n```\n\nUse `install_github()` to install {svPkgdown} from GitHub (source from\n**main** branch will be recompiled on your machine):\n\n``` r\nremotes::install_github(\"SciViews/svPkgdown\")\n```\n\nR should install all required dependencies automatically, and then it\nshould compile and install {svPkgdown}.\n\n## How to use {svPkgdown}\n\nStarting from a GitHub repository for an R package with no {pkgdown}\nsite yet,\n\n- upgrade {usethis} to the latest development version using\n  `remotes::install_github(\"r-lib/usethis\")` if needed.\n- In you GitHub repo do `usethis::use_pkgdown()` then,\n  `pkgdown::build_site()` to view how it renders with all defaults.\n- Add `docs` and `docs/` in `.gitignore` to avoid pushing your local\n  version of the site to GitHub.\n- Edit `_pkgdown.yml`. For SciViews, a custom template is used by means\n  of this {svPkgdown} package, based on the bootstrap `spacelab`\n  template. You may also place additional information for the authors,\n  for instance:\n\n``` yaml\nurl: https://www.sciviews.org/svPkgdown\n\ndestination: docs\n\ndevelopment:\n  mode: auto\n\ntemplate:\n  package: svPkgdown\n  bootstrap: 3\n  bootswatch: spacelab\n  params:\n    mathjax: true\n  bslib:\n    pkgdown-nav-height: 80px\n    code_font: {google: \"JetBrains Mono\"}\n\ntoc:\n  depth: 3\n\nnavbar:\n  structure:\n    left:  [intro, reference, articles, tutorials, news]\n    right: [search, github]\n\nhome:\n  strip_header: true\n\nauthors:\n  Philippe Grosjean:\n    href: https://phgrosjean.sciviews.org/\n```\n\n- Regenerate your site with `pkgdown::build_site()`, or from RStudio,\n  from the corresponding addin. Check its appearance.\n- Create a GitHub action to automatically regenerate the site on GitHub\n  on every push with `usethis::use_github_action(\"pkgdown\")`.\n- Commit and push, then check if the action is run (click on the little\n  icon on the left of “Latest commit …” on the main page of the\n  repository).\n- In the repo settings, activate or reactivate **Pages** -\\\u003e **source**\n  -\\\u003e “gh-pages branch” -\\\u003e **/root**. You may also check “Enforce\n  HTTPS”. Navigate to your site (the URL is provided directly in the\n  settings page). If it does not work, try another push to refresh the\n  site.\n- Once your site is operational, refer to it in the main page of your\n  repo (edit the description at the top, and may be also place a link to\n  it in the `README.md` file).\n\nFurther explanations on how to customize the {pkgdown} site\n[here](https://github.com/tidyverse/tidytemplate).\n\n## Example sites\n\n- [{svUnit}](https://www.SciViews.org/svUnit/)\n\n- [{svGUI}](https://www.SciViews.org/svGUI/)\n\n- [{svMisc}](https://www.SciViews.org/svMisc/)\n\n## Further explore {svPkgdown}\n\nYou can get further help about this package this way:\n\n``` r\nlibrary(help = \"svPkgdown\")\npackage?svPkgdown\nvignette(\"svPkgdown\") # None is installed with install_github()\n```\n\nFor further instructions, please, refer to the related web site at\n\u003chttps://www.sciviews.org/svPkgdown/\u003e.\n\n## Code of Conduct\n\nPlease note that the {inferit} package is released with a [Contributor\nCode of\nConduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).\nBy contributing to this project, you agree to abide by its terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsciviews%2Fsvpkgdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsciviews%2Fsvpkgdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsciviews%2Fsvpkgdown/lists"}