Merge pull request #13 from uribo/feature/pkgdown

pkgdownによるウェブサイトの構築

.Rbuildignore

@@ -11,3 +11,6 @@
 ^inst/real$
 ^cran-comments\.md$
 ^CRAN-SUBMISSION$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/.gitignore

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

.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
+  pull_request:
+    branches: main
+  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/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -9,3 +9,4 @@ data-raw/*.csv
 *.xlsx
 *.zip
 inst/besttrack/
+docs

DESCRIPTION

@@ -16,7 +16,7 @@ Depends:
     R (>= 4.1)
 License: MIT + file LICENSE
 BugReports: https://github.com/uribo/jmastats/issues
-URL: https://github.com/uribo/jmastats
+URL: https://uribo.github.io/jmastats/, https://github.com/uribo/jmastats
 Imports: 
     cli (>= 3.4.0),
     crayon (>= 1.3.4),

_pkgdown.yml

@@ -0,0 +1,6 @@
+url: https://uribo.github.io/jmastats/
+authors:
+  Shinya Uryu:
+    href: https://suryu.me
+template:
+  bootstrap: 5