diff --git a/.Rbuildignore b/.Rbuildignore index 5f3d199..a95dfdc 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,3 +3,6 @@ ^LICENSE\.md$ ^README\.Rmd$ ^\.github$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..a7276e8 --- /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@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/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index 5b6a065..234f028 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ .Rhistory .RData .Ruserdata +docs diff --git a/DESCRIPTION b/DESCRIPTION index c91aad7..97c2fd6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -23,3 +23,4 @@ Language: en-GB LazyData: true RoxygenNote: 7.3.1 Roxygen: list(markdown = TRUE) +URL: http://katilingban.io/pakete/ diff --git a/R/add_issue_templates.R b/R/add_issue_templates.R index c3ddd2b..c8e1f03 100644 --- a/R/add_issue_templates.R +++ b/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`. diff --git a/README.Rmd b/README.Rmd index 3de8312..463193a 100644 --- a/README.Rmd +++ b/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 diff --git a/README.md b/README.md index c6f819c..5aad70f 100644 --- a/README.md +++ b/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 diff --git a/inst/WORDLIST b/inst/WORDLIST new file mode 100644 index 0000000..59db697 --- /dev/null +++ b/inst/WORDLIST @@ -0,0 +1,12 @@ +CMD +CodeFactor +Katilingban +Lifecycle +ORCID +WIP +Zenodo +cran +github +md +repostatus +wip diff --git a/man/add_issue.Rd b/man/add_issue.Rd index f6d3fb5..d9c58d6 100644 --- a/man/add_issue.Rd +++ b/man/add_issue.Rd @@ -15,7 +15,7 @@ are \emph{"initial-cran-release"}, \emph{"update-cran-release"}, ".github/ISSUE_TEMPLATE" which is the default location specified by GitHub.} -\item{overwrite}{Logical. If an exising issue template with the same file +\item{overwrite}{Logical. If an existing issue template with the same file name is found, should it be overwritten? Default to FALSE.} } \value{ diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml new file mode 100644 index 0000000..98bcd86 --- /dev/null +++ b/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 diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png new file mode 100644 index 0000000..464fe56 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-120x120.png differ diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png new file mode 100644 index 0000000..5337952 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-152x152.png differ diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png new file mode 100644 index 0000000..3cb4872 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-180x180.png differ diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png new file mode 100644 index 0000000..9b8ed38 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-60x60.png differ diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png new file mode 100644 index 0000000..9cc541c Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon-76x76.png differ diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png new file mode 100644 index 0000000..8469939 Binary files /dev/null and b/pkgdown/favicon/apple-touch-icon.png differ diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png new file mode 100644 index 0000000..eca2c83 Binary files /dev/null and b/pkgdown/favicon/favicon-16x16.png differ diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png new file mode 100644 index 0000000..f9e33ec Binary files /dev/null and b/pkgdown/favicon/favicon-32x32.png differ diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico new file mode 100644 index 0000000..739ca59 Binary files /dev/null and b/pkgdown/favicon/favicon.ico differ