https://github.com/dieghernan/gitdevr

A pkgdown' template for my packages. Template based on skin GitDev of my Jekyll template chulapa: https://dieghernan.github.io/chulapa/skins/gitdev
https://github.com/dieghernan/gitdevr

pkgdown pkgdown-template r r-package

Last synced: about 1 month ago
JSON representation

A pkgdown' template for my packages. Template based on skin GitDev of my Jekyll template chulapa: https://dieghernan.github.io/chulapa/skins/gitdev

• Host: GitHub
• URL: https://github.com/dieghernan/gitdevr
• Owner: dieghernan
• License: other
• Created: 2023-06-09T06:24:14.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-09T20:30:56.000Z (about 1 month ago)
• Last Synced: 2024-08-09T21:44:14.019Z (about 1 month ago)
• Topics: pkgdown, pkgdown-template, r, r-package
• Language: CSS
• Homepage: https://dieghernan.github.io/gitdevr/
• Size: 7.75 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE
  • Citation: CITATION.cff
  • Codemeta: codemeta.json

Awesome Lists containing this project

• jimsghstars - dieghernan/gitdevr - A pkgdown' template for my packages. Template based on skin GitDev of my Jekyll template chulapa: https://dieghernan.github.io/chulapa/skins/gitdev (CSS)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# gitdevr 

[![Lifecycle:

experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![.github/workflows/check-simple.yaml](https://github.com/dieghernan/gitdevr/actions/workflows/check-simple.yaml/badge.svg)](https://github.com/dieghernan/gitdevr/actions/workflows/check-simple.yaml)

## Overview

**gitdevr** provides a custom [pkgdown](https://pkgdown.r-lib.org) template

based on the [GitDev skin](https://dieghernan.github.io/chulapa/skins/gitdev)

provided with my Jekyll theme [chulapa](https://dieghernan.github.io/chulapa/).

See a preview of the template in 

## Installation

You can install the developing version of **gitdevr** with:

```{r, eval=FALSE}

devtools::install_github("dieghernan/gitdevr")

```

Alternatively, you can install **gitdevr** using the

[r-universe](https://dieghernan.r-universe.dev/gitdevr):

```{r, eval=FALSE}

# Install gitdevr in R:

install.packages("gitdevr", repos = c(

  "https://dieghernan.r-universe.dev",

  "https://cloud.r-project.org"

))

```

## Usage

After the successful installation, if you already have your **pkgdown** setup

ready, you only need to specify the `template` parameter as follow. Then, as

before, you can build your site using `pkgdown::build_site()`.

```yml

template:

  bootstrap: 5

  package: gitdevr

```

> Keep in mind that you should NOT use `default_assets: false` when you change

> the default template. **gitdevr** relies on some of the **pkgdown** assets and

> templates.

It is recommended to add the following line to your `DESCRIPTION`:

```         

Config/Needs/website: dieghernan/gitdevr

```

By doing so, when using [r-lib

actions](https://github.com/r-lib/actions/tree/v2-branch/setup-r-dependencies)

for deploying your site, the github action would install the package for you

automatically.