build site

.Rbuildignore

@@ -3,3 +3,7 @@
 ^LICENSE\.md$
 ^README\.Rmd$
 ^cran-comments\.md$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/pkgdown.yaml

@@ -0,0 +1,50 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+permissions: read-all
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -4,3 +4,4 @@
 .httr-oauth
 .DS_Store
 .quarto
+docs

DESCRIPTION

@@ -12,5 +12,5 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2.9000
-URL: https://github.com/luisDVA/hexsession
+URL: https://github.com/luisDVA/hexsession, https://luisdva.github.io/hexsession/
 BugReports: https://github.com/luisDVA/hexsession/issues

README.Rmd

@@ -20,7 +20,7 @@ knitr::opts_chunk$set(
 [![CRAN status](https://www.r-pkg.org/badges/version/hexsession)](https://CRAN.R-project.org/package=hexsession)
 <!-- badges: end -->
 
-The goal of hexsession is to create tile of hexagonal logos for each loaded package in a session (all packages attached to the search path except for base packages). 
+The goal of hexsession is to create a tile of hexagonal logos for each loaded package in a session (all packages attached to the search path except for base packages). 
 
 ## Installation
 
@@ -65,12 +65,16 @@ hexsession::make_tile()
 ```
 
 The output would look like this: 
-![](man/figures/exampletile.png)
+![](man/figures/hsdemo.gif)
+_I don't know how to show the rendered interactive file on the GitHub readme, if anyone does please let me know 😅._
 
-Once downloaded, the [hexout_example.html](inst/extdata/hexout_example.html) shows the interactive, responsive HTML version that adapts to the size of the browser window and includes hyperlinks to each package website.
+Once downloaded to your machine and opened in a browser, the [hexout_example.html](inst/extdata/hexout_example.html) shows the interactive, responsive HTML version with cool hover effects that adapts to the size of the browser window and includes hyperlinks to each package website.
 
 To save a static version of the hex tile, we call `snap_tile()` with a path to the output image and optionally, height and width values to change the viewport size. 
 
+The result: 
+
+![](man/figures/exampletile.png)
 
 ## Notes
 

README.md

@@ -11,7 +11,7 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
 status](https://www.r-pkg.org/badges/version/hexsession)](https://CRAN.R-project.org/package=hexsession)
 <!-- badges: end -->
 
-The goal of hexsession is to create tile of hexagonal logos for each
+The goal of hexsession is to create a tile of hexagonal logos for each
 loaded package in a session (all packages attached to the search path
 except for base packages).
 
@@ -62,17 +62,24 @@ library(patchwork)
 hexsession::make_tile()
 ```
 
-The output would look like this: ![](man/figures/exampletile.png)
+The output would look like this: ![](man/figures/hsdemo.gif) *I don’t
+know how to show the rendered interactive file on the GitHub readme, if
+anyone does please let me know 😅.*
 
-Once downloaded, the
+Once downloaded to your machine and opened in a browser, the
 [hexout_example.html](inst/extdata/hexout_example.html) shows the
-interactive, responsive HTML version that adapts to the size of the
-browser window and includes hyperlinks to each package website.
+interactive, responsive HTML version with cool hover effects that adapts
+to the size of the browser window and includes hyperlinks to each
+package website.
 
 To save a static version of the hex tile, we call `snap_tile()` with a
 path to the output image and optionally, height and width values to
 change the viewport size.
 
+The result:
+
+![](man/figures/exampletile.png)
+
 ## Notes
 
 This packages depends on working installations of magick, Quarto, and

_pkgdown.yml

@@ -0,0 +1,4 @@
+url: https://luisdva.github.io/hexsession/
+template:
+  bootstrap: 5
+

pkgdown/favicon/site.webmanifest

@@ -0,0 +1,21 @@
+{
+  "name": "MyWebSite",
+  "short_name": "MySite",
+  "icons": [
+    {
+      "src": "/web-app-manifest-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png",
+      "purpose": "maskable"
+    },
+    {
+      "src": "/web-app-manifest-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png",
+      "purpose": "maskable"
+    }
+  ],
+  "theme_color": "#ffffff",
+  "background_color": "#ffffff",
+  "display": "standalone"
+}