diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml index cda12b9..2cf703d 100644 --- a/.github/workflows/label.yml +++ b/.github/workflows/label.yml @@ -7,6 +7,6 @@ jobs: triage: runs-on: ubuntu-latest steps: - - uses: actions/labeler@v4 + - uses: actions/labeler@v5 with: repo-token: '${{ secrets.GITHUB_TOKEN }}' diff --git a/.github/workflows/quarto-publish.yml b/.github/workflows/quarto-publish.yml new file mode 100644 index 0000000..4a23503 --- /dev/null +++ b/.github/workflows/quarto-publish.yml @@ -0,0 +1,80 @@ +on: + push: + branches: + - main + workflow_dispatch: + +name: Render and Publish + +# you need these permissions to publish to GitHub pages +permissions: + contents: write + pages: write + +jobs: + build-deploy: + runs-on: ubuntu-latest + + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Set up Quarto + uses: quarto-dev/quarto-actions/setup@v2 + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # with: + # To install LaTeX to build PDF book outputs, uncomment below + # tinytex: true + # uncomment below and fill to pin a version + # version: SPECIFIC-QUARTO-VERSION-HERE + + # add software dependencies here and any libraries + + # From https://github.com/actions/setup-python + # - name: Setup Python + # uses: actions/setup-python@v3 + + # From https://github.com/r-lib/actions/tree/v2-branch/setup-r + # - name: Setup R + # uses: r-lib/actions/setup-r@v2 + + # From https://github.com/julia-actions/setup-julia + # - name: Setup Julia + # uses: julia-actions/setup-julia@v1 + + # See more at https://github.com/quarto-dev/quarto-actions/blob/main/examples/example-03-dependencies.md + + # To publish to Netlify, RStudio Connect, or GitHub Pages, uncomment + # the appropriate block below + + # - name: Publish to Netlify (and render) + # uses: quarto-dev/quarto-actions/publish@v2 + # with: + # target: netlify + # NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + + # - name: Publish to RStudio Connect (and render) + # uses: quarto-dev/quarto-actions/publish@v2 + # with: + # target: connect + # CONNECT_SERVER: enter-the-server-url-here + # CONNECT_API_KEY: ${{ secrets.CONNECT_API_KEY }} + + # NOTE: If Publishing to GitHub Pages, set the permissions correctly (see top of this yaml) + - name: Publish to GitHub Pages (and render) + uses: quarto-dev/quarto-actions/publish@v2 + with: + target: gh-pages + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # this secret is always available for github actions + + + # - name: Publish to confluence + # uses: quarto-dev/quarto-actions/publish@v2 + # with: + # target: confluence + # env: + # CONFLUENCE_USER_EMAIL: ${{ secrets.CONFLUENCE_USER_EMAIL }} + # CONFLUENCE_AUTH_TOKEN: ${{ secrets.CONFLUENCE_AUTH_TOKEN }} + # CONFLUENCE_DOMAIN: ${{ secrets.CONFLUENCE_DOMAIN }} diff --git a/.gitignore b/.gitignore index 1fadca7..c0e2964 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# Quarto +.quarto/ +_site/ + # Exclude example.env !example.env diff --git a/LICENSE-AGPL b/LICENSE-AGPL.md similarity index 100% rename from LICENSE-AGPL rename to LICENSE-AGPL.md diff --git a/LICENSE-CCBY b/LICENSE-CCBY.md similarity index 100% rename from LICENSE-CCBY rename to LICENSE-CCBY.md diff --git a/README.md b/README.md index 2d708c9..010b1ea 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ This GitHub template is independent of the (research) data and its format. It fo - [CHANGELOG.md](CHANGELOG.md) according to [keepachangelog.com](https://keepachangelog.com/) - Automated [CHANGELOG.md](CHANGELOG.md) via [git-cliff](https://github.com/orhun/git-cliff) - [package.json](package.json) via [npm docs](https://docs.npmjs.com/cli/v7/configuring-npm/package-json) -- Accessible documentation via [gh-pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages) +- Accessible documentation via [gh-pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages) and [Quarto](https://quarto.org/) ### Consistency @@ -79,6 +79,7 @@ npm run prepare - [ ] run `npm run commit` to commit all changes - [ ] run `npm run changelog` and include the output in [CHANGELOG.md](CHANGELOG.md) - [ ] enable [gh-pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages) +- [ ] customize the documentation with [Quarto](https://quarto.org/docs/websites/#workflow) 3. optional tasks: @@ -140,5 +141,6 @@ See also the list of [contributors](https://github.com/maehr/open-research-data- ## License -The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the [LICENSE-CCBY](LICENSE-CCBY) file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made. -The code in this repository is released under the GNU Affero General Public License v3.0 - see the [LICENSE-AGPL](LICENSE-AGPL) file for details. By using this code, you agree to make any modifications available under the same license. +The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the [LICENSE-CCBY](LICENSE-CCBY.md) file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made. + +The code in this repository is released under the GNU Affero General Public License v3.0 - see the [LICENSE-AGPL](LICENSE-AGPL.md) file for details. By using this code, you agree to make any modifications available under the same license. diff --git a/README.template.md b/README.template.md index 1e9d308..9083cd1 100644 --- a/README.template.md +++ b/README.template.md @@ -81,6 +81,6 @@ See also the list of [contributors](https://github.com/USERNAME/REPO_NAME/graphs ## License -The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the [LICENSE-CCBY](LICENSE-CCBY) file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made. +The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the [LICENSE-CCBY](LICENSE-CCBY.md) file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made. -The code in this repository is released under the GNU Affero General Public License v3.0 - see the [LICENSE-AGPL](LICENSE-AGPL) file for details. By using this code, you agree to make any modifications available under the same license. +The code in this repository is released under the GNU Affero General Public License v3.0 - see the [LICENSE-AGPL](LICENSE-AGPL.md) file for details. By using this code, you agree to make any modifications available under the same license. diff --git a/_config.yml b/_config.yml deleted file mode 100644 index 012ff0a..0000000 --- a/_config.yml +++ /dev/null @@ -1,3 +0,0 @@ -theme: jekyll-theme-minimal -logo: android-chrome-512x512.png -show_downloads: true diff --git a/_layouts/default.html b/_layouts/default.html deleted file mode 100644 index 1a07f84..0000000 --- a/_layouts/default.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -
- - - - - {% seo %} - - - - - - - - - -{{ site.description | default: site.github.project_tagline }}
- - {% if site.github.is_project_page %} - - {% endif %} - - {% if site.github.is_user_page %} - - {% endif %} - - {% if site.show_downloads %} - - {% endif %} -