From 7adf7213bbca3eee09655a96ee0be6ed18a2a675 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Tue, 13 Feb 2024 00:13:04 +0100 Subject: [PATCH] feat: quarto support added --- .github/workflows/quarto-publish.yml | 78 ++++++++++++++++++++++++++++ .gitignore | 3 ++ _quarto.yml | 60 +++++++++++++++++++++ index.qmd | 1 + project-management/communication.md | 4 +- project-management/people.md | 4 +- project-management/project-report.md | 4 +- project-management/tools.md | 4 +- report.md | 4 +- styles.css | 1 + 10 files changed, 158 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/quarto-publish.yml create mode 100644 _quarto.yml create mode 100644 index.qmd create mode 100644 styles.css diff --git a/.github/workflows/quarto-publish.yml b/.github/workflows/quarto-publish.yml new file mode 100644 index 0000000..3dc0bde --- /dev/null +++ b/.github/workflows/quarto-publish.yml @@ -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 }} diff --git a/.gitignore b/.gitignore index 1fadca7..dfaf3a3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# Quarto +/.quarto/ + # Exclude example.env !example.env diff --git a/_quarto.yml b/_quarto.yml new file mode 100644 index 0000000..c2e7686 --- /dev/null +++ b/_quarto.yml @@ -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 diff --git a/index.qmd b/index.qmd new file mode 100644 index 0000000..a738d0d --- /dev/null +++ b/index.qmd @@ -0,0 +1 @@ +{{< include README.md >}} \ No newline at end of file diff --git a/project-management/communication.md b/project-management/communication.md index 7271b2c..90022ab 100644 --- a/project-management/communication.md +++ b/project-management/communication.md @@ -1,3 +1,5 @@ -# 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. diff --git a/project-management/people.md b/project-management/people.md index 7271b2c..3ddb297 100644 --- a/project-management/people.md +++ b/project-management/people.md @@ -1,3 +1,5 @@ -# 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. diff --git a/project-management/project-report.md b/project-management/project-report.md index 7271b2c..e11e3f3 100644 --- a/project-management/project-report.md +++ b/project-management/project-report.md @@ -1,3 +1,5 @@ -# 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. diff --git a/project-management/tools.md b/project-management/tools.md index 7271b2c..43f7aaa 100644 --- a/project-management/tools.md +++ b/project-management/tools.md @@ -1,3 +1,5 @@ -# 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. diff --git a/report.md b/report.md index 7271b2c..fc30334 100644 --- a/report.md +++ b/report.md @@ -1,3 +1,5 @@ -# 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. diff --git a/styles.css b/styles.css new file mode 100644 index 0000000..2ddf50c --- /dev/null +++ b/styles.css @@ -0,0 +1 @@ +/* css styles */