Skip to content

Commit

Permalink
Try update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Feb 6, 2024
1 parent f9f7076 commit 4088341
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion inst/pkgdown/templates/navbar.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light">
<div class="container">
<a class="navbar-brand me-2" href="{{#site}}{{root}}{{/site}}index.html">
<img src="{{#site}}{{root}}{{/site}}logo.png" alt="{{#site}}{{title}}{{/site}} logo" height="40" class="d-inline-block me-1">{{#site}}{{title}}{{/site}}</a>
<img src="{{#site}}{{root}}{{/site}}favicon-32x32.png" alt="{{#site}}{{title}}{{/site}} logo" height="40" class="d-inline-block me-1">{{#site}}{{title}}{{/site}}</a>

<small class="nav-text {{#development}}text-{{version_label}}{{/development}} me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="{{#development}}{{version_tooltip}}{{/development}}">{{#package}}{{version}}{{/package}}</small>

Expand Down
16 changes: 9 additions & 7 deletions vignettes/rostemplate.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ knitr::opts_chunk$set(
)
```

# Introducción
## Introducción

Este paquete proporciona una plantilla de `pkgdown` adaptada a la empleada por
la comunidad [rOpenSpain](https://ropenspain.es/), que a su vez es una
Expand All @@ -39,7 +39,7 @@ pequeños fragmentos en `javascript`.
Otra limitación es la diferencia de versiones Bootstrap, ya que esta plantilla
`pkgdown` emplea la versión Bootstrap 5 mientras que Universal emplea la 3.3.7.

# Configuración previa
## Configuración previa

En la raíz del proyecto ha de existir un archivo `_pkgdown.yml` con al menos las
siguientes líneas:
Expand All @@ -63,14 +63,15 @@ líneas:
^_pkgdown\.yml$
```

# Uso de la plantilla

## Uso de la plantilla

Esta sección detalla diferentes opciones para generar un sitio estático para el
paquete deseado con el formato definido por esta plantilla. El resultado de este
paso es la generación de un sitio estático compuesto de los archivos `html`,
`css`, etc. basados en el paquete de R para el que se está generando el sitio.

## Con GitHub actions - CI
### Con GitHub actions - CI

GitHub Actions permite automatizar procesos cuando se activa un *trigger*. En
este caso se han preparado dos acciones que actualizan el sitio estático cada
Expand All @@ -86,7 +87,7 @@ Para configurar esta opción, es necesario disponer en el repositorio de una
carpeta en la ruta `.github/workflows` y copiar la acción deseada en dicha
carpeta.

### Alternativa usando las funciones de `rostemplate`
#### Alternativa usando las funciones de `rostemplate`

Aunque el uso del paquete `rostemplate` en si no es necesario con GitHub
actions, se han desarrollado dos funciones que automatizan esta configuración de
Expand All @@ -102,6 +103,7 @@ compila el paquete:
install.packages("rostemplate",
repos = c("https://ropenspain.r-universe.dev", "https://cloud.r-project.org")
)
# Deploy to gh-branch
rostemplate::ros_actions_pkgdown_branch()
Expand Down Expand Up @@ -132,7 +134,7 @@ on:
Más información sobre cómo adaptar los *triggers* de la acción
[aquí](https://docs.github.com/es/free-pro-team@latest/actions/reference/events-that-trigger-workflows).

## RStudio - manual
### RStudio - manual

El sitio estático se puede generar igualmente desde una sesión local en RStudio.
Para ello, es necesario instalar este paquete:
Expand All @@ -156,7 +158,7 @@ del archivo `_pkgdown.yml`
Una vez generado el sitio, es necesario actualizar el repositorio remoto en
GitHub mediante un *commit*.

# GitHub Pages
## GitHub Pages

Una vez generado el sitio estático y subido al repositorio en GitHub, el último
paso es activar el sitio web a través de los *Settings* de nuestro repositorio
Expand Down

0 comments on commit 4088341

Please sign in to comment.