Merge pull request #78 from hadley/pkgdown

Add basic website

.Rbuildignore

@@ -10,3 +10,6 @@
 ^CRAN-RELEASE$
 ^\.github$
 ^codecov\.yml$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/workflows/pkgdown.yaml

@@ -0,0 +1,41 @@
+# 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
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - 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: Rscript -e 'pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)'
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -2,3 +2,4 @@
 inst/doc
 .Rhistory
 revdep/checks
+docs

DESCRIPTION

@@ -43,3 +43,4 @@ Collate:
     'shortcuts.R'
     'wildcards.R'
     'zzz.R'
+Config/Needs/website: r-lib/pkgdown

_pkgdown.yml

@@ -0,0 +1,33 @@
+url: https://kevinushey.github.io/rex
+template:
+  bootstrap: 5
+
+reference:
+- title: Create a regular expression
+  contents:
+  - rex
+  - capture
+  - character_class
+  - n_times
+  - group
+  - "`%if_next_is%`"
+  - not
+  - or
+  - zero_or_more
+
+- title: String manipulation
+  contents:
+  - re_matches
+  - re_substitutes
+
+- title: For developers
+  contents:
+  - as.regex
+  - as.character.regex
+  - character_class_escape
+  - escape
+  - shortcuts
+  - single_shortcuts
+  - register_shortcuts
+  - rex_mode
+