pkgdown website

.Rbuildignore

@@ -6,3 +6,6 @@
 ^\.github$
 ^cran-comments\.md$
 ^CRAN-SUBMISSION$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.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
+
+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/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -2,3 +2,5 @@
 .Rhistory
 .RData
 .Ruserdata
+docs
+inst/doc

DESCRIPTION

@@ -25,10 +25,14 @@ Imports:
     tarchetypes,
     targets,
     withr
-URL: https://github.com/daranzolin/sqltargets
+URL: https://github.com/daranzolin/sqltargets,
+    https://daranzolin.github.io/sqltargets/
 BugReports: https://github.com/daranzolin/sqltargets/issues
 RoxygenNote: 7.2.1
 Suggests: 
     testthat (>= 3.0.0),
-    RSQLite (>= 2.2.0)
+    RSQLite (>= 2.2.0),
+    knitr,
+    rmarkdown
 Config/testthat/edition: 3
+VignetteBuilder: knitr

_pkgdown.yml

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

vignettes/.gitignore

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

vignettes/intro-to-sqltargets.Rmd

@@ -0,0 +1,19 @@
+---
+title: "Introduction to sqltargets"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Introduction to sqltargets}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(sqltargets)
+```