Add quillt structure and template (#108)
diff --git a/.Rbuildignore b/.Rbuildignore
index 59fc2cd..849f518 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -6,3 +6,7 @@
^codecov\.yml$
^\.github$
+^_pkgdown\.yml$
+^reference$
+^pkgdown$
+^vignettes/articles$
\ No newline at end of file
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..ebcf2a9
--- /dev/null
+++ b/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,126 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards
+of acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies
+when an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at codeofconduct@rstudio.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0,
+available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..57778b4
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+# Contributing to revealjs
+
+We welcome contributions to the **revealjs** package.
+
+You can contribute in many ways:
+
+* By opening issues to give feedback and share ideas.
+* By fixing typos in documentations
+* By submitting Pull Request (PR) to fix some opened issues
+* By submitting Pull Request (PR) to suggest some new features. (It is considered good practice to open issues before to discuss ideas)
+
+
+## To submit a contribution using a Pull Request:
+
+1. [Fork](https://github.com/rstudio/bookdown/fork) the repository and make your changes in a new branch specific to the PR. It is ok to edit a file in this repository using the `Edit` button on Github if the change is simple enough.
+
+2. For significant changes (e.g not required for fixing typos), ensure that you have signed the [individual](https://rstudioblog.files.wordpress.com/2017/05/rstudio_individual_contributor_agreement.pdf) or [corporate](https://rstudioblog.files.wordpress.com/2017/05/rstudio_corporate_contributor_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to <jj@rstudio.com>.
+
+3. Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as draft in your are still working on it but would like some feedback from us. It always good to share in the open that you are working on it.
+
+We'll try to be as responsive as possible in reviewing and accepting pull requests. Appreciate your contributions very much!
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
index f2f400f..1b17b80 100644
--- a/.github/workflows/R-CMD-check.yaml
+++ b/.github/workflows/R-CMD-check.yaml
@@ -7,8 +7,15 @@
on:
push:
branches: [main, master]
+ paths-ignore:
+ - 'pkgdown/**'
+ - '.github/workflows/pkgdown.yaml'
pull_request:
branches: [main, master]
+ paths-ignore:
+ - 'pkgdown/**'
+ - '.github/workflows/pkgdown.yaml'
+
name: R-CMD-check
@@ -76,3 +83,10 @@
with:
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
path: check
+
+ - name: Test coverage
+ if: success() && runner.os == 'Linux' && matrix.config.r == 'release' && matrix.config.pandoc == '2.11.4'
+ run: |
+ pak::pkg_install('covr')
+ covr::codecov()
+ shell: Rscript {0}
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
new file mode 100644
index 0000000..c23da9f
--- /dev/null
+++ b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,59 @@
+on:
+ push:
+ branches: [main, master]
+ tags: ['*']
+ pull_request:
+ branches: [main, master]
+name: pkgdown
+
+jobs:
+ pkgdown:
+ if: ${{ github.event_name == 'push' || startsWith(github.head_ref, 'pkgdown/') }}
+ runs-on: ubuntu-latest
+ env:
+ GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+ steps:
+ - uses: actions/checkout@v2
+
+ - uses: r-lib/actions/setup-pandoc@v1
+
+ - uses: r-lib/actions/setup-r@v1
+ with:
+ use-public-rspm: true
+
+ - uses: r-lib/actions/setup-r-dependencies@v1
+ with:
+ needs: website
+
+ - name: Install package
+ run: R CMD INSTALL .
+
+ - name: Cache some pkgdown assets
+ uses: actions/cache@v2
+ with:
+ path: |
+ vignettes/articles/images/*.png
+ key: 1-${{ hashFiles('vignettes/articles/examples.yml') }}
+
+ - name: Build pkgdown site
+ run: pkgdown::build_site(new_process = FALSE)
+ shell: Rscript {0}
+
+ - name: Deploy to Netlify
+ if: false() # TODO: setup netlify
+ id: netlify-deploy
+ uses: nwtgck/actions-netlify@v1.1
+ with:
+ publish-dir: 'reference'
+ # change back to master if branch is not correct
+ production-branch: main
+ github-token: ${{ secrets.GITHUB_TOKEN }}
+ deploy-message:
+ 'Deploy from GHA: ${{ github.event.head_commit.message }} (${{ github.sha }})'
+ enable-pull-request-comment: false
+ enable-commit-comment: false
+ enable-commit-status: true
+ alias: deploy-preview-${{ github.event.number }}
+ env:
+ NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+ NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
deleted file mode 100644
index 3c0da1c..0000000
--- a/.github/workflows/test-coverage.yaml
+++ /dev/null
@@ -1,30 +0,0 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/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]
-
-name: test-coverage
-
-jobs:
- test-coverage:
- runs-on: ubuntu-latest
- env:
- GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
-
- steps:
- - uses: actions/checkout@v2
-
- - uses: r-lib/actions/setup-r@v1
- with:
- use-public-rspm: true
-
- - uses: r-lib/actions/setup-r-dependencies@v1
- with:
- extra-packages: covr
-
- - name: Test coverage
- run: covr::codecov()
- shell: Rscript {0}
diff --git a/.gitignore b/.gitignore
index 807ea25..22c33ab 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
.Rproj.user
.Rhistory
.RData
+reference
diff --git a/DESCRIPTION b/DESCRIPTION
index 02829c9..4b43cf9 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -35,6 +35,7 @@
Suggests:
covr,
testthat
+Config/needs/website: rstudio/pkgdown, rstudio/quillt
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.2
diff --git a/README.Rmd b/README.Rmd
index dddaf68..15c729a 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -385,3 +385,7 @@
```
All documents located in the same directory as `_output.yaml` will inherit it's options. Options defined explicitly within documents will override those specified in the shared options file.
+
+## Code of Conduct
+
+Please note that the revealjs project is released with a [Contributor Code of Conduct](https://pkgs.rstudio.com/revealjs/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644
index 0000000..65265a8
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,79 @@
+destination: reference
+
+# website will be referenced on https://pkgs.rstudio.com/
+# Open a PR in https://github.com/rstudio/pkgs.rstudio.com
+# url: https://pkgs.rstudio.com/revealjs/
+
+template:
+ package: quillt
+ opengraph:
+ # image:
+ # src: man/figures/logo.png
+ # alt: "revealjs package"
+ twitter:
+ creator: "@rstudio"
+ card: summary
+
+development:
+ version_tooltip: "Development version"
+
+home:
+ strip_header: false
+ links:
+ - text: Learn more
+ # if relevant, set url to another website i.e https://rmarkdown.rstudio.com
+ href: ""
+
+# structure of website themed with quillt
+navbar:
+ title: ~
+ type: default
+ structure:
+ left: [intro, examples, articles]
+ right: [reference, news, github]
+ components:
+ home: ~
+ examples:
+ text: Examples
+ href: articles/articles/examples.html
+ articles:
+ text: Articles
+ menu:
+ - text: "No Article"
+ reference:
+ text: Reference
+ href: reference/index.html
+ github:
+ icon: fab fa-github fa-lg
+ href: https://github.com/rstudio/revealjs
+ news:
+ text: News
+ menu:
+ - text: "Changelog"
+ href: news/index.html
+ - text: "------------------"
+ - text: "Blog posts"
+ # Add blog post where a released version is mentioned.
+ - text: "No blog post"
+ # - text: Version 0.2
+ # href: <url>
+
+# structure example
+# reference:
+# - title: Output formats
+# desc: >
+# These output formats are for building ...
+# contents:
+#
+# - title: Previewing and rendering books
+# contents:
+#
+# - title: Publishing
+# desc: >
+# Publish...
+#
+#
+# - title: Helper functions
+# desc: >
+# These functions are utility functions when working with **revealjs**.
+# contents:
diff --git a/vignettes/articles/examples.Rmd b/vignettes/articles/examples.Rmd
new file mode 100644
index 0000000..69b4ac7
--- /dev/null
+++ b/vignettes/articles/examples.Rmd
@@ -0,0 +1,19 @@
+---
+title: "Example projects"
+resource_files:
+ - images/
+---
+
+```{r setup, include = FALSE}
+library(quillt)
+```
+
+
+The examples below illustrate the use of revealjs with various packages and layouts. If you want to learn more about how the dashboards were created each example includes a link to its source code.
+
+
+```{r, echo=FALSE}
+examples(yml = "examples.yml")
+```
+
+**blogdown** repo contains an example on how to dynamically generate the `example.yml` taking screenshot of the featured examples. See [`example.Rmd`](https://github.com/rstudio/blogdown/blob/master/vignettes/articles/examples.Rmd) in the repository.
diff --git a/vignettes/articles/examples.yml b/vignettes/articles/examples.yml
new file mode 100644
index 0000000..fc13082
--- /dev/null
+++ b/vignettes/articles/examples.yml
@@ -0,0 +1,7 @@
+# - title: Title to use
+# img: image local or url
+# href: link to the example
+# source: link to the source repo
+# # (optional) allows to filter examples
+# showcase: true
+# shiny: true
diff --git a/vignettes/revealjs.Rmd b/vignettes/revealjs.Rmd
new file mode 100644
index 0000000..ad9b037
--- /dev/null
+++ b/vignettes/revealjs.Rmd
@@ -0,0 +1,31 @@
+---
+title: "Learn revealjs"
+output: rmarkdown::html_vignette
+vignette: >
+ %\VignetteIndexEntry{Learn
+ %\VignetteEngine{knitr::rmarkdown}
+ %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+ collapse = TRUE,
+ comment = "#>"
+)
+```
+
+# Overview
+
+If you are new to using revealjs, we encourage you to ...
+
+# User Guide
+
+Written by ...
+
+# Going further with examples
+
+Learn from examples at ...
+
+# Cheatsheets
+
+You can access it at...