From ac161b078590489bf277312b86e9a615a5cc544d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pawe=C5=82?= <kpawel2210@gmail.com>
Date: Tue, 25 Jul 2023 16:39:07 +0200
Subject: [PATCH] pkgdown site added

---
 .Rbuildignore                  |  3 +++
 .github/workflows/pkgdown.yaml | 48 ++++++++++++++++++++++++++++++++++
 .gitignore                     |  2 ++
 DESCRIPTION                    |  4 +++
 _pkgdown.yml                   |  6 +++++
 vignettes/.gitignore           |  2 ++
 6 files changed, 65 insertions(+)
 create mode 100644 .github/workflows/pkgdown.yaml
 create mode 100644 _pkgdown.yml
 create mode 100644 vignettes/.gitignore

diff --git a/.Rbuildignore b/.Rbuildignore
index c8f7b04..e1d8ad3 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -2,3 +2,6 @@
 ^\.Rproj\.user$
 ^LICENSE\.md$
 ^\.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
new file mode 100644
index 0000000..ed7650c
--- /dev/null
+++ b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,48 @@
+# 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
+    # 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@v3
+
+      - 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.4.1
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
index cd67eac..a948606 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,3 @@
 .Rproj.user
+docs
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
index 5ca76f7..b44ba90 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -19,5 +19,9 @@ Imports:
     tidyr,
     vcfR
 Suggests: 
+    knitr,
+    rmarkdown,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
+URL: https://pawelqs.github.io/readthis/
+VignetteBuilder: knitr
diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644
index 0000000..21ae2fb
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,6 @@
+url: https://pawelqs.github.io/readthis/
+template:
+  bootstrap: 5
+  bootswatch: flatly
+  bslib:
+    pkgdown-nav-height: 100px
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
new file mode 100644
index 0000000..097b241
--- /dev/null
+++ b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R