Skip to content

Commit

Permalink
feat: quarto support added
Browse files Browse the repository at this point in the history
  • Loading branch information
maehr committed Feb 12, 2024
1 parent 1b5417b commit 7adf721
Show file tree
Hide file tree
Showing 10 changed files with 158 additions and 5 deletions.
78 changes: 78 additions & 0 deletions .github/workflows/quarto-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
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
with:
# To install LaTeX to build PDF book
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 }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Quarto
/.quarto/

# Exclude example.env
!example.env

Expand Down
60 changes: 60 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
project:
type: website

website:
title: REPO_NAME
favicon: android-chrome-512x512.png
open-graph: true
twitter-card: true
site-url: https://USERNAME.github.io/REPO_NAME/
repo-url: https://github.com/USERNAME/REPO_NAME/
issue-url: https://github.com/USERNAME/REPO_NAME/issues/new/choose
repo-actions: [edit, issue]
page-navigation: true
bread-crumbs: true
back-to-top-navigation: true
search:
show-item-context: true
type: overlay
navbar:
logo: android-chrome-512x512.png
logo-alt: ''
title: REPO_NAME
tools:
- icon: github
url: https://github.com/USERNAME/REPO_NAME/
left:
- text: Readme
href: index.qmd
- text: Report
href: report.md

sidebar:
contents:
- section: REPO_NAME
href: index.qmd
contents:
- text: Changelog
href: CHANGELOG.md
- text: Code of Conduct
href: CODE_OF_CONDUCT.md
- text: Contributing
href: CONTRIBUTING.md
- text: License
href: LICENSE.md
- text: Security
href: SECURITY.md
- href: report.md
contents: project-management/*

format:
html:
toc: true
theme: cosmo
code-copy: true
code-overflow: wrap
css: styles.css

freeze: true

editor: visual
1 change: 1 addition & 0 deletions index.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{< include README.md >}}
4 changes: 3 additions & 1 deletion project-management/communication.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# TODO
<!-- TODO -->

# Communication

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
4 changes: 3 additions & 1 deletion project-management/people.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# TODO
<!-- TODO -->

# People

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
4 changes: 3 additions & 1 deletion project-management/project-report.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# TODO
<!-- TODO -->

# Project Report

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
4 changes: 3 additions & 1 deletion project-management/tools.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# TODO
<!-- TODO -->

# Tools

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
4 changes: 3 additions & 1 deletion report.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# TODO
<!-- TODO -->

# Report

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
1 change: 1 addition & 0 deletions styles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/* css styles */

0 comments on commit 7adf721

Please sign in to comment.