Set up pkgdown (#134)

* Set up pkgdown

* extra ws

.Rbuildignore

@@ -8,3 +8,6 @@
 README.md
 ^NEWS\.[0-9]+$
 ^codecov\.yml$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.devcontainer/r-420/Dockerfile

@@ -10,6 +10,6 @@ RUN Rscript -e '                           \
   remotes::install_deps(dependencies = c(  \
     "Depends",                             \
     "Imports",                             \
-    "Config/needs/development"             \
+    "Config/Needs/development"             \
   ))                                       \
 '

.devcontainer/r-devel/Dockerfile

@@ -11,6 +11,6 @@ RUN Rscript -e '                                \
   remotes::install_deps(dependencies = c(       \
     "Depends",                                  \
     "Imports",                                  \
-    "Config/needs/development"                  \
+    "Config/Needs/development"                  \
   ))                                            \
 '

.github/workflows/pkgdown.yaml

@@ -0,0 +1,49 @@
+# 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:
+  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

@@ -42,3 +42,4 @@ src/*.dll
 doc
 Meta
 
+docs

DESCRIPTION

@@ -22,13 +22,14 @@ Description:
 License: GPL-2 | GPL-3
 LazyLoad: yes
 ByteCompile: yes
-URL: https://github.com/r-lib/bit64
+URL: https://github.com/r-lib/bit64, https://bit64.r-lib.org
 Encoding: UTF-8
 Imports: graphics, methods, stats, utils
 Suggests: 
     testthat (>= 3.0.3),
     withr
 Config/testthat/edition: 3
-Config/needs/development: testthat
+Config/Needs/development: testthat
+Config/Needs/website: tidyverse/tidytemplate
 RoxygenNote: 7.3.2
 Roxygen: list(markdown = TRUE)

_pkgdown.yml

@@ -0,0 +1,9 @@
+url: https://bit64.r-lib.org
+template:
+  package: tidytemplate
+  bootstrap: 5
+  includes:
+    in_header: |
+      <script defer data-domain="bit64.r-lib.org,all.tidyverse.org" src="https://plausible.io/js/plausible.js"></script>
+development:
+  mode: auto