https://github.com/ropensci-org/rotemplate

pkgdown template for rOpenSci packages :nail_care: :sparkles:
https://github.com/ropensci-org/rotemplate

pkgdown r r-package rstats

Last synced: 3 months ago
JSON representation

pkgdown template for rOpenSci packages :nail_care: :sparkles:

• Host: GitHub
• URL: https://github.com/ropensci-org/rotemplate
• Owner: ropensci-org
• License: other
• Created: 2019-03-11T16:04:47.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-12-04T18:06:48.000Z (11 months ago)
• Last Synced: 2024-02-20T19:13:52.430Z (9 months ago)
• Topics: pkgdown, r, r-package, rstats
• Language: R
• Homepage: https://docs.ropensci.org/rotemplate
• Size: 529 KB
• Stars: 25
• Watchers: 2
• Forks: 6
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - ropensci-org/rotemplate - pkgdown template for rOpenSci packages :nail_care: :sparkles: (R)

README

        
# rotemplate 

rotemplate provides a custom pkgdown template for rOpenSci packages. We

use this to render sites at `https://docs.ropensci.org`. Please don’t

use it for your own package if it’s not an rOpenSci package (i.e. only

use it for packages listed on ).

Inspired by [tidytemplate](https://github.com/tidyverse/tidytemplate/)

and [lockedatapkg](https://github.com/lockedatapublished/lockedatapkg).

## How to use `rotemplate`

Documentation rOpenSci packages will automatically be generated from

your master branch and published to . You

don’t have to do anything to make this work. If you want to test your

site locally use this:

``` r

library(rotemplate)

#install.packages("yourpkg")

rotemplate::build_ropensci_docs("path/to/yourpkg")

```

Everything else can be configured as usual via the `_pkgdown.yml` file

as described in the pkgdown documentation.

If your website is not deploying or you run into another problem, please

open an issue in the [ropensci/docs](https://github.com/ropensci/docs)

repository.

### Math rendering

Please refer to [pkgdown documentation](https://pkgdown.r-lib.org/dev/articles/customise.html#math-rendering).

## Example sites

-   [`cyphr`](https://docs.ropensci.org/cyphr/)

-   [`drake`](https://docs.ropensci.org/drake/)

-   [`riem`](https://docs.ropensci.org/riem/)

-   [`rotl`](https://docs.ropensci.org/rotl/)

-   [`stplanr`](https://docs.ropensci.org/stplanr/)

-   [`visdat`](http://visdat.njtierney.com/)

-   [`magick`](https://docs.ropensci.org/magick/)