Merge pull request #15 from katilingban/dev

setup pkgdown

.Rbuildignore

@@ -3,3 +3,6 @@
 ^LICENSE\.md$
 ^README\.Rmd$
 ^\.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.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@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

@@ -2,3 +2,4 @@
 .Rhistory
 .RData
 .Ruserdata
+docs

DESCRIPTION

@@ -23,3 +23,4 @@ Language: en-GB
 LazyData: true
 RoxygenNote: 7.3.1
 Roxygen: list(markdown = TRUE)
+URL: http://katilingban.io/pakete/

R/add_issue_templates.R

@@ -7,7 +7,7 @@
 #' @param path Path to file to add issue template into. Set to
 #'   ".github/ISSUE_TEMPLATE" which is the default location specified by
 #'   GitHub.
-#' @param overwrite Logical. If an exising issue template with the same file
+#' @param overwrite Logical. If an existing issue template with the same file
 #'   name is found, should it be overwritten? Default to FALSE.
 #'
 #' @returns A specified issue template markdown file in the specified `path`.

README.Rmd

@@ -74,7 +74,7 @@ If you need help with getting specific language for a `CONTRIBUTING.md` document
 add_contributing(repo = "YOUR_GITHUB_USERNAME/YOUR_REPO_NAME")
 ```
 
-This will create a `CONTRIBUTING.md` file within the `.github` directory (this will be created if it doesn't exist). Do note that the contributing process described in this markdown document is the preferred process of those who developed the `pakete` package. If you are starting out and need something to use or somethign to build on, then this can help.
+This will create a `CONTRIBUTING.md` file within the `.github` directory (this will be created if it doesn't exist). Do note that the contributing process described in this markdown document is the preferred process of those who developed the `pakete` package. If you are starting out and need something to use or something to build on, then this can help.
 
 ### Adding a `repostatus` badge
 

README.md

@@ -96,7 +96,7 @@ This will create a `CONTRIBUTING.md` file within the `.github` directory
 (this will be created if it doesn’t exist). Do note that the
 contributing process described in this markdown document is the
 preferred process of those who developed the `pakete` package. If you
-are starting out and need something to use or somethign to build on,
+are starting out and need something to use or something to build on,
 then this can help.
 
 ### Adding a `repostatus` badge

inst/WORDLIST

@@ -0,0 +1,12 @@
+CMD
+CodeFactor
+Katilingban
+Lifecycle
+ORCID
+WIP
+Zenodo
+cran
+github
+md
+repostatus
+wip

pkgdown/_pkgdown.yml

@@ -0,0 +1,56 @@
+title: pakete
+
+url: https://katilingban.io/pakete/
+
+template:
+  bootstrap: 5
+  bootswatch: sandstone
+  theme: haddock
+  ganalytics: #
+
+home:
+  links:
+  - text: Learn more about Katilingban
+    href: https://katilingban.io
+
+navbar:
+  bg: primary
+  type: light
+  structure:
+    left:  [home, intro, reference, articles, news]
+    right: [mastodon, linkedin, github]
+
+  components:
+    # articles:
+    #   text: Articles
+    #   menu:
+    #   - text: "Africa CDC"
+    #     href: articles/africa-cdc.html
+    #   - text: "World Bank"
+    #     href: articles/world-bank.html
+    #   - text: "UNICEF"
+    #     href: articles/unicef.html
+    #   - text: "NHS"
+    #     href: articles/nhs.html
+    mastodon:
+      icon: "fab fa-mastodon fa-lg"
+      href: https://fosstodon.org/@katilingban
+    linkedin:
+      icon: "fab fa-linkedin fa-lg"
+      href: https://www.linkedin.com/company/katilingban
+
+reference:
+  - title: Badges and logo
+    contents:
+    - add_badge_status
+    - add_badge_codefactor
+    - add_badge_zenodo
+    - add_logo
+
+  - title: Document templates
+    contents:
+    - add_contributing
+
+  - title: Issues templates
+    contents:
+    - add_issue_template