Skip to content

Commit

Permalink
Deploy pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
strohne committed May 17, 2024
1 parent 751e832 commit 342e458
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 5 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 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

permissions: read-all

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
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Description: Craft polished tables and plots in Markdown reports.
and the package will automatically generate well-designed default tables and plots for you.
Boiled down to the basics, with labeling features and simple interactive reports.
All functions are 'tidyverse' compatible.
URL: https://github.com/strohne/volker
URL: https://github.com/strohne/volker, https://strohne.github.io/volker/
BugReports: https://github.com/strohne/volker/issues
License: MIT + file LICENSE
Encoding: UTF-8
Expand Down
14 changes: 10 additions & 4 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
url: ~
url: https://strohne.github.io/volker/
template:
bootstrap: 5

navbar:
structure:
left: [intro, introduction, reference, news]
right: [search, github]
left:
- intro
- introduction
- reference
- news
right:
- search
- github
components:
introduction:
text: Introduction
href: articles/introduction.html

0 comments on commit 342e458

Please sign in to comment.