Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
53 changes: 53 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Build the pkgdown site and deploy it to the gh-pages branch.
# Replaces serving the site from the tracked `docs/` folder on main.
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
release:
types: [published]
workflow_dispatch:

name: pkgdown.yaml

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'
# Pinned to a commit SHA (v4.8.0) — this step runs with contents: write
# (can push to gh-pages), so a moving tag must not be able to execute here.
uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
with:
clean: false
branch: gh-pages
folder: docs
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@ VignetteBuilder: knitr
Roxygen: list(markdown = TRUE)
Config/testthat/edition: 3
Config/roxygen2/version: 8.0.0
Config/Needs/website: tidyverse/tidytemplate
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@

> **DataTables v2 for R** — modular, lightweight, works with or without Shiny.

> [!NOTE]
> **Using Python?** A companion port, [**dt2**](https://github.com/StrategicProjects/dt2py),
> brings the same DataTables v2 API to [Shiny for Python](https://shiny.posit.co/py/)
> via [anywidget](https://anywidget.dev). Docs: <https://strategicprojects.github.io/dt2py/>
> · PyPI: `pip install dt2`.

DT2 is a modern `htmlwidgets` binding for
[DataTables.net v2](https://datatables.net/) with:

Expand Down
7 changes: 6 additions & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,13 @@ template:
navbar:
structure:
left: [intro, reference, articles]
right: [search, github]
right: [python, search, github]
components:
python:
icon: fa-python
href: https://strategicprojects.github.io/dt2py/
aria-label: Python port (dt2)
text: Python
github:
icon: fa-github
href: https://github.com/StrategicProjects/DT2
Expand Down
1 change: 0 additions & 1 deletion docs/.nojekyll

This file was deleted.

90 changes: 0 additions & 90 deletions docs/404.html

This file was deleted.

3 changes: 0 additions & 3 deletions docs/404.md

This file was deleted.

61 changes: 0 additions & 61 deletions docs/LICENSE-text.html

This file was deleted.

4 changes: 0 additions & 4 deletions docs/LICENSE-text.md

This file was deleted.

Binary file removed docs/apple-touch-icon.png
Binary file not shown.
Loading
Loading