https://github.com/sosiristseng/template-quarto-julia-matrix

https://github.com/sosiristseng/template-quarto-julia-matrix

julia quarto template

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/sosiristseng/template-quarto-julia-matrix
• Owner: sosiristseng
• License: mit
• Created: 2023-09-13T03:46:22.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-10T16:32:06.000Z (9 months ago)
• Last Synced: 2024-04-10T20:10:19.490Z (9 months ago)
• Topics: julia, quarto, template
• Language: Julia
• Homepage: https://sosiristseng.github.io/template-quarto-julia-matrix/
• Size: 163 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Template publishing Julia-kerneled Jupyter notebooks with dynamic matrix and Quarto

Click `Use this template` button to copy this repository.

See also:

- [template-juliabook](https://github.com/ww-jl/template-juliabook): runs notebooks concurrently *in one runner* and use [jupyter-book][] to build the website.

- [template-juliabook-matrix](https://github.com/sosiristseng/template-juliabook-matrix): mostly the same as this repository, but it uses [jupyter-book][] to render the website.

[quarto]: https://quarto.org/

[jupyter-book]: https://jupyterbook.org/

## Notebook execution and publish

- Workflow file: [ci.yml](.github/workflows/ci.yml)

The notebooks under the `docs` folder are executed in parallel, and then [Quarto][quarto] creates a beautiful website from Markdown and Jupyter notebook files.

## Enable GitHub pages

Open your repository settings => Pages => GitHub Pages => Build and deployment => Source, select `GitHub actions`.

## Automatic dependency updates

### Dependabot and Kodiak Bot

See [dependabot.yml](.github/dependabot.yml) and [.kodiak.toml](.github/.kodiak.toml) configuration files.

You need to enable the [Kodiak Bot](https://kodiakhq.com/docs/quickstart) APP to automatically merge updates.

### Julia dependencies

The GitHub workflow [update-manifest.yml](.github/workflows/update-manifest.yml) regularly updates Julia dependencies, make a PR with the updated dependencies, and automatically merge the updates if the notebooks are executed smoothly.

See [creating tokens](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs) to trigger CI workflows in a PR. This repo uses a custom [GitHub APP](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens) to generate a token on the fly.

## Checking HTTP links

[linkcheck.yml](.github/workflows/linkcheck.yml) uses GitHub actions to regularly check if the web links in the notebooks are valid.